summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Pointner <equinox@spreadspace.org>2014-08-03 20:01:33 +0200
committerChristian Pointner <equinox@spreadspace.org>2014-08-03 20:01:33 +0200
commitb1f152cda43c8096d2a060439d09b138402621f2 (patch)
treed4feeced9562f1c81228b3e0ff1cc6294e55eb2a
parentadded initial files (diff)
added some documentation
-rw-r--r--doc/charting-library-evaluation.md3
-rw-r--r--doc/protocol.md26
2 files changed, 29 insertions, 0 deletions
diff --git a/doc/charting-library-evaluation.md b/doc/charting-library-evaluation.md
new file mode 100644
index 0000000..a294c72
--- /dev/null
+++ b/doc/charting-library-evaluation.md
@@ -0,0 +1,3 @@
+ * Flot [link](http://www.flotcharts.org/)
+ * CanvaJS [link](http://canvasjs.com/)
+ * Leaflet [link](https://github.com/Leaflet/Leaflet.markercluster)
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,
+ ....
+ }
+}