# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1579442136 -3600
# Node ID c240934703bc1a2d3289f5770d3a6b3623abac53
# Parent  c065b7670c897e7a524fdc6849e5dd0289f3141e
mod_stats39: Add a README

diff -r c065b7670c89 -r c240934703bc mod_stats39/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_stats39/README.markdown	Sun Jan 19 14:55:36 2020 +0100
@@ -0,0 +1,42 @@
+This module provides **public** access to Prosodys
+[internal statistics][doc:statistics] trough the
+[XEP-0039: Statistics Gathering] protocol. This is a simple protocol
+that returns triplets of name, unit and value for each know statistic
+collected by Prosody. The names used are the internal names assigned by
+modules or statsmanager, names from the registry are **not** used.
+
+# Configuration
+
+Enabled as usual by adding to [`modules_enabled`][doc:modules_enabled]:
+
+```lua
+-- Enable Prosodys internal statistics gathering
+statistics = "internal"
+
+-- and enable the module
+modules_enabled = {
+    -- other modules
+    "stats39";
+}
+```
+
+# Usage
+
+
+## Example
+
+Statistics can be queried from the XML console of clients that have one:
+
+```xml
+C:
+<iq type="get" to="example.com" id="dTMERjt5">
+  <query xmlns="http://jabber.org/protocol/stats"/>
+</iq>
+
+S:
+<iq type="result" to="example.com" id="dTMERjt5">
+  <query xmlns="http://jabber.org/protocol/stats">
+  </query>
+</iq>
+```
+