diff --git a/README.md b/README.md index 4a508c41a..4d1e1449d 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ emqttd is a massively scalable and clusterable MQTT V3.1/V3.1.1 broker written i emqttd requires Erlang R17+ to build. + ## Goals emqttd is aimed to provide a solid, enterprise grade, extensible open-source MQTT broker for IoT(M2M) applications that need to support ten millions of concurrent MQTT clients. @@ -14,11 +15,8 @@ emqttd is aimed to provide a solid, enterprise grade, extensible open-source MQT * Easy to extend * Solid stable -## Design -![emqttd architecture](http://emqtt.io/static/img/Architecture.png) - -## Featues +## Features * Full MQTT V3.1/V3.1.1 protocol specification support * QoS0, QoS1, QoS2 Publish and Subscribe @@ -30,7 +28,7 @@ emqttd is aimed to provide a solid, enterprise grade, extensible open-source MQT * HTTP Publish API Support * [$SYS/borkers/#](https://github.com/emqtt/emqtt/wiki/$SYS-Topics-of-Broker) Support * Client Authentication with clientId, ipaddress -* Client Authentication with username, password. +* Client Authentication with username, password. * Client ACL control with ipaddress, clientid, username. * Cluster brokers on several servers. * Bridge brokers locally or remotelly @@ -38,11 +36,19 @@ emqttd is aimed to provide a solid, enterprise grade, extensible open-source MQT * Extensible architecture with plugin support * Passed eclipse paho interoperability tests + +## Design + +![emqttd architecture](http://emqtt.io/static/img/Architecture.png) + + ## QuickStart Download binary packeges for linux, mac and freebsd from [http://emqtt.io/downloads](http://emqtt.io/downloads). -``` +For example: + +```sh tar xvf emqttd-ubuntu64-0.7.0-alpha.tgz && cd emqttd # start console @@ -66,20 +72,24 @@ git clone https://github.com/emqtt/emqttd.git cd emqttd && make && make dist ``` + ## GetStarted Read [Get Started](https://github.com/emqtt/emqttd/wiki/Get-Started) for more installation and configuration guide. + ## Benchmark Benchmark 0.6.1-alpha on a ubuntu/14.04 server with 8 cores, 32G memory from QingCloud: 200K+ Connections, 200K+ Topics, 20K+ In/Out Messages/sec, 20Mbps+ In/Out with 8G Memory, 50%CPU/core + ## License The MIT License (MIT) + ## Contributors [@hejin1026](https://github.com/hejin1026) @@ -87,6 +97,7 @@ The MIT License (MIT) [@turtleDeng](https://github.com/turtleDeng) [@Hades32](https://github.com/Hades32) + ## Author Feng Lee