design

README.md

@@ -1,74 +1,76 @@
-emqtt
+# eMQTT
-=====
 
-erlang mqtt broker.
+eMQTT is a scalable, fault-tolerant and extensible mqtt broker written in Erlang/OTP.
 
-requires
+eMQTT requires Erlang R17+.
-========
 
-erlang R15B+ 
+## Startup in Five Minutes
 
-git client
+```
+	$ git clone git://github.com/slimpp/emqtt.git
 
-build
+	$ cd emqtt
-=======
 
-make
+	$ make && make generate
 
-release
+	$ cd rel/emqtt
-=======
 
-make generate
+	$ ./bin/emqtt console
+```
 
-deloy
+## Deploy and Start
-=====
 
+### start
+
+```
 	cp -R rel/emqtt $INSTALL_DIR
 
-start
+	cd $INSTALL_DIR/emqtt
-======
-
-cd $INSTALL_DRI/emqtt
-
-./bin/emqtt console
-
-or
 
 	./bin/emqtt start
 
-status
+```
-======
 
-./bin/emqtt_ctl status
+### stop
-
-stop
-====
 
+```
 	./bin/emqtt stop
 
-logs
+```
-====
 
-log/*
+## HTTP API
 
-http api
+eMQTT support http to publish message.
-========
 
-curl -v --basic -u user:passwd -d "topic=/abc&message=akakakk&qos=0" -k http://localhost:8883/mqtt/publish
+Example:
 
-design
+```
-=====
+	curl -v --basic -u user:passwd -d "topic=/a/b/c&message=hello from http..." -k http://localhost:8883/mqtt/publish
+```
 
-https://github.com/slimpp/emqtt/wiki
+### URL
 
-author
+```
-=====
+	HTTP POST http://host:8883/mqtt/publish
+```
 
-Ery Lee <ery.lee at gmail dot com>
+### Parameters
 
+Name | Description
+-----|-------------
+topic | MQTT Topic
+message | Text Message
 
-license
+## Design
-======
+
+[Design Wiki](https://github.com/slimpp/emqtt/wiki)
+
+## License
 
 The MIT License (MIT)
 
+## Author
+=====
+
+feng at slimchat.io
+