# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1485879964 -3600
# Node ID c98b37d6d86c6d3c06d4c6fe8aa69ea1b09f3e4a
# Parent  a440f0514c2acef8ef6a218795e361533825e878
mod_http_stats_stream: Add a README

diff -r a440f0514c2a -r c98b37d6d86c mod_http_stats_stream/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_http_stats_stream/README.markdown	Tue Jan 31 17:26:04 2017 +0100
@@ -0,0 +1,37 @@
+---
+depends:
+- 'mod\_http'
+provides:
+- http
+---
+
+# Introduction
+
+This module provides a streaming interface to [Prosodys internal statistics][doc:statistics] via
+[Server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events).
+
+## Example
+
+```js
+var evtSource = new EventSource("/stats_stream");
+
+/*
+ * An event with all current statistics in the form of a JSON object.
+ * Normally sent only once, when first connected to the stream.
+ */
+evtSource.addEventListener("stats-full", function(e) {
+	var initial_stats = JSON.parse(e.data);
+	console.log(initial_stats);
+}, false);
+
+/*
+ * An event containing only statistics that have changed since the last
+ * 'stats-full' or 'stats-updated' event.
+ */
+evtSource.addEventListener("stats-updated", function(e) {
+	var updated_stats = JSON.parse(e.data);
+	console.log(updated_stats);
+}, false);
+```
+
+