anna/IM-server-new
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #370 from ningg/master

Browse Source 
feature: update Readme file.
This commit is contained in:
Andrea Selva
2017-10-31 14:54:03 +01:00
committed by GitHub
parent 95a8b313e5 f8c1a95b63
commit 5d02ecdf94
1 changed files with 21 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+21 -10
View File
@@ -3,25 +3,31 @@
[![Build Status](https://api.travis-ci.org/andsel/moquette.svg?branch=master)](https://travis-ci.org/andsel/moquette)
* [Documentation reference guide] (http://andsel.github.io/moquette/) Guide on how to use and configure Moquette
* [Google Group] (https://groups.google.com/forum/#!forum/moquette-mqtt) Google Group to participate in development discussions.
* [Documentation reference guide](http://andsel.github.io/moquette/) Guide on how to use and configure Moquette
* [Google Group](https://groups.google.com/forum/#!forum/moquette-mqtt) Google Group to participate in development discussions.
Moquette aims to be a MQTT compliant broker. The broker supports QoS 0, QoS 1 and QoS 2.
Its designed to be evented, uses Netty for the protocol encoding and decoding part.
## Embeddable
[Freedomotic] (http://www.freedomotic.com/) Is an home automation framework, uses Moquette embedded to interface with MQTT world.
Moquette is also used into [Atomize Spin] (http://atomizesoftware.com/spin) a software solution for the logistic field.
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/)
and into [WSO2 Messge broker] (http://techexplosives-pamod.blogspot.it/2014/05/mqtt-transport-architecture-wso2-mb-3x.html).
[Freedomotic](http://www.freedomotic.com/) Is an home automation framework, uses Moquette embedded to interface with MQTT world.
Moquette is also used into [Atomize Spin](http://atomizesoftware.com/spin) a software solution for the logistic field.
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/)
and into [WSO2 Messge broker](http://techexplosives-pamod.blogspot.it/2014/05/mqtt-transport-architecture-wso2-mb-3x.html).
## Try the demo instance
Point your MQTT client to _broker.moquette.io_
## 1 minute set up
Start play with it, download the self distribution tar from [BinTray](https://bintray.com/artifact/download/andsel/generic/distribution-0.10-bundle-tar.tar.gz) ,
the un untar and start the broker listening on 1883 port and enjoy!
the un untar and start the broker listening on `1883` port and enjoy!
```
tar zxf distribution-0.10-bundle-tar.tar.gz
cd bin
@@ -29,12 +35,14 @@ cd bin
```
Or if you are on Windows shell
```
cd bin
.\moquette.bat
```
```
## Embedding in other projects
To embed Moquette in another maven project is sufficient to include a repository and declare the dependency:
```
@@ -64,7 +72,10 @@ Include dependency in your project:
## Build from sources
After a git clone of the repository, cd into the cloned sources and: `./gradlew clean distribution:distMoquetteTar` or
`./gradlew clean distribution:distMoquetteZip`.
After a git clone of the repository, cd into the cloned sources and: `./gradlew clean distribution:distMoquetteTar` or
`./gradlew clean distribution:distMoquetteZip`.
In distribution/build directory will be produced the selfcontained file for the broker with all dependencies and a running script.