mod_pubsub_stats: Add a brief README
authorKim Alvefur <zash@zash.se>
Thu, 28 Jun 2018 17:43:23 +0200
changeset 3160 50618747e00e
parent 3159 6e5bde0879ad
child 3161 8a870e0319db
mod_pubsub_stats: Add a brief README
mod_pubsub_stats/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_pubsub_stats/README.markdown	Thu Jun 28 17:43:23 2018 +0200
@@ -0,0 +1,13 @@
+This module publishes data from internal statistics into a PubSub node
+in [XEP-0039] format.
+
+The node defaults to `stats` but can be changed with the option
+`pubsub_stats_node`.
+
+``` lua
+Component "pubsub.example.com" "pubsub"
+modules_enabled = {
+    "pubsub_stats";
+}
+pubsub_stats_node = "statistics"
+```