Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tebemis committed Aug 6, 2014
1 parent 20c2d9f commit c994864
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,30 @@
# Simple MQTT Client in Java [![Build Status](https://travis-ci.org/ltg-uic/simple-java-mqtt-client.svg?branch=master)](https://travis-ci.org/ltg-uic/simple-java-mqtt-client)

A simple asynchronous MQTT client written in Java.

## Hello world
## Download
You can either download the zip file from the releases on Github [here](https://github.com/ltg-uic/simple-java-mqtt-client/releases) or use Maven. If you are using Maven, add the following to your project `pom.xml` file.
```xml
<project ...>
...
<repositories>
<repository>
<id>LTG</id>
<url>http://ltg.evl.uic.edu/artifactory/repo</url>
</repository>
</repositories>
...
<dependencies>
<dependency>
<groupId>ltg</groupId>
<artifactId>simple-java-mqtt-client</artifactId>
<version>1.0.0</version>
</dependency>
</dependencies>
...
</project>
```

## Hello world
```java
import ltg.commons.SimpleMQTTClient;

Expand Down Expand Up @@ -36,5 +57,5 @@ public class MQTTClientDemo {
For a complete example see `MQTTClientDemo.java` in `ltg.commons.examples`.

# Important note
This library is based off of a fixed version of the [Eclipse Paho java library](http://www.eclipse.org/paho/clients/java/).
This library is based off of a fixed version of the [Eclipse Paho java library](http://www.eclipse.org/paho/clients/java/). Hopefully they will fix their broken Maven repo and release system one day.

0 comments on commit c994864

Please sign in to comment.