Skip to content

Commit

Permalink
Updated the README for the release
Browse files Browse the repository at this point in the history
  • Loading branch information
christianrowlands committed Jul 10, 2021
1 parent 0ba6261 commit 023651e
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The MQTT Connection Library provides a simple connection UI as well as logic to
It is important to note that the pieces provided in the library cannot stand on their own. Most classes are to be extended or implemented, as an "MQTT Connection" relies on a service that drives the logic using the connection. We will go over the correct way to wire everything together below.
1. Ensure that the correct version of the library is included in the consuming project's `build.gradle` file, under its dependencies:<br><br>
```
implementation 'com.craxiom:mqttlibrary:0.4.0'
implementation 'com.craxiom:mqttlibrary:0.4.3'
```
2. Next, for the connection UI, the `fragment_mqtt_connection` is readily available under `res/layout`; however, `AConnectionFragment` must still be extended, or `DefaultConnectionFragment`.<br>Note: Users can extend the latter if they do not wish to add extra UI components. Otherwise, extend `AConnectionFragment`, which contains methods marked with "additional" in their names and <i>must</i> be overridden in the child class.<br>
&ensp; a. Whichever fragment ends up being extended, it will require a binder parameter. This binder should extend the provided `AConnectionFragment#ServiceBinder` in order to be recognized. Likely, this binder will be located in the `IMqttService` implementation of the consuming project.
Expand All @@ -25,6 +25,9 @@ It is important to note that the pieces provided in the library cannot stand on


## Change log
##### [0.4.3](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.4.3) - 2021-07-10
* Added some defensive programming when updating the UI state if the fragment has been detached.

##### [0.4.2](https://github.com/christianrowlands/android-mqtt-connection-lib/releases/tag/v0.4.2) - 2021-06-28
* Fixed a bug where the MQTT connection would not reestablish when the Internet connection dropped.

Expand Down

0 comments on commit 023651e

Please sign in to comment.