Skip to content

Commit 4209906

Browse files
authored
Updated Readme (moquette-io#875)
1 parent facdc39 commit 4209906

File tree

1 file changed

+21
-38
lines changed

1 file changed

+21
-38
lines changed

README.md

+21-38
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,25 @@
1-
ServerIntegrationOpenSSLTest![Java CI with Maven](https://github.com/moquette-io/moquette/workflows/Java%20CI%20with%20Maven/badge.svg?branch=main)
2-
3-
## Moquette Project
4-
5-
[![Build Status](https://api.travis-ci.org/moquette-io/moquette.svg?branch=main)](https://travis-ci.org/moquette-io/moquette)
6-
7-
* [Documentation reference guide](http://moquette-io.github.io/moquette/) Guide on how to use and configure Moquette
8-
* [Google Group](https://groups.google.com/forum/#!forum/moquette-mqtt) Google Group to participate in development discussions.
9-
10-
Moquette aims to be a MQTT compliant broker. The broker supports QoS 0, QoS 1 and QoS 2.
1+
[Java CI with Maven](https://github.com/moquette-io/moquette/workflows/Java%20CI%20with%20Maven/badge.svg?branch=main)
2+
3+
## Moquette MQTT broker
4+
[Documentation reference guide](http://moquette-io.github.io/moquette/) Guide on how to use and configure Moquette
5+
6+
Moquette is a lightweight broker compliant with MQTT 5 and MQTT 3, easily encapsulated in other applications.
7+
The broker supports QoS 0, QoS 1 and QoS 2. The MQTT5 specification is almost fully supported.
8+
The features implemented by the broker are:
9+
* session and message expiry
10+
* shared subscriptions
11+
* request/response
12+
* topic alias
13+
* flow control
14+
* subscription options
15+
* will delay
16+
* server disconnects
17+
* payload format indicator
1118

1219
Its designed to be evented, uses Netty for the protocol encoding and decoding part.
13-
14-
## Embeddable
15-
16-
[Freedomotic](https://www.freedomotic-iot.com/) is an home automation framework and uses Moquette embedded to interface with MQTT by a specific [plugin](https://freedomotic-user-manual.readthedocs.io/en/latest/plugins/mqtt-broker.html).
17-
18-
Moquette is also used into [Atomize Spin](http://atomizesoftware.com/spin) a software solution for the logistic field.
19-
20-
Part of moquette are used into the [Vertx MQTT module](https://github.com/giovibal/vertx-mqtt-broker-mod), into [MQTT spy](http://kamilfb.github.io/mqtt-spy/)
21-
and into [WSO2 Messge broker](http://techexplosives-pamod.blogspot.it/2014/05/mqtt-transport-architecture-wso2-mb-3x.html).
22-
23-
## 1 minute set up
2420

25-
Start play with it, download the self distribution tar from [BinTray](https://bintray.com/artifact/download/andsel/generic/moquette-0.15.tar.gz) ,
26-
the un untar and start the broker listening on `1883` port and enjoy!
27-
28-
```
29-
tar xvf moquette-distribution-0.15.tar.gz
30-
cd bin
31-
./moquette.sh
32-
```
33-
34-
Or if you are on Windows shell
35-
36-
```
37-
cd bin
38-
.\moquette.bat
39-
```
21+
## Community feedback
22+
We would love to hear from the users of Moquette, please :pry: let us know in [this discussion thread](https://github.com/moquette-io/moquette/discussions/874)
4023

4124
## Embedding in other projects
4225

@@ -46,13 +29,13 @@ Include dependency in your project:
4629
<dependency>
4730
<groupId>io.moquette</groupId>
4831
<artifactId>moquette-broker</artifactId>
49-
<version>0.15</version>
32+
<version>0.17</version>
5033
</dependency>
5134
```
5235

5336
## Build from sources
5437

5538
After a git clone of the repository, cd into the cloned sources and: `./gradlew package`, at the end the distribution
56-
package is present at `distribution/target/distribution-0.17-SNAPSHOT-bundle.tar.gz`
39+
package is present at `distribution/target/distribution-0.18-SNAPSHOT-bundle.tar.gz`
5740

5841
In distribution/target directory will be produced the selfcontained file for the broker with all dependencies and a running script.

0 commit comments

Comments
 (0)