update README

plucury · Jun 4, 2012 · b270c23 · b270c23
1 parent 0775917
commit b270c23
Showing 1 changed file with 14 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,15 @@
-mqtt.go
-=======
+#mqtt.go
+
+an MQTT encoder & decoder,written in GO lang (*version 1.0.1*)
+
+##Functions
+* `func Encode(mqtt *Mqtt) (byte[], error)`
+
+	Convert Mqtt struct to bit stream.
+
+* `func Decode(bitstream byte[]) (*Mqtt, error)`
+
+	Convert bit stream to Mqtt struct
+
+
 
-an MQTT encoder & decoder,written in GO lang