added some documentation

1 files changed, 26 insertions, 0 deletions

diff --git a/doc/protocol.md b/doc/protocol.md
new file mode 100644
index 0000000..282c863
--- /dev/null
+++ b/doc/protocol.md
@@ -0,0 +1,26 @@
+# Messages
+
+## init
+
+{
+  "hostname": "myhostname",
+  "streamer-id": { "content-id": "av-orig", "format": "flash", "quality": "medium" },
+  "tags": [ "elevate", "2014", "discourse" ]
+}
+
+## data-update
+
+{
+  "start-time": "2014-08-03Z12:34:56.123",
+  "duration-ms": 5000,
+  "data": {
+    "clients": [
+       { "ip": "127.0.0.1:2345", "bytes-transferred": 12094, "user-agent": "Mozilla Version 28", .... },
+        .....
+    ],
+    "client-count": 12,
+    "bytes-received": 12345,
+    "bytes-sent": 921734098,
+     ....
+  }
+}