From b1f152cda43c8096d2a060439d09b138402621f2 Mon Sep 17 00:00:00 2001 From: Christian Pointner Date: Sun, 3 Aug 2014 20:01:33 +0200 Subject: added some documentation --- doc/charting-library-evaluation.md | 3 +++ doc/protocol.md | 26 ++++++++++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 doc/charting-library-evaluation.md create mode 100644 doc/protocol.md 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, + .... + } +} -- cgit v1.2.3