Changeset

3156:50618747e00e

mod_pubsub_stats: Add a brief README
author Kim Alvefur <zash@zash.se>
date Thu, 28 Jun 2018 17:43:23 +0200
parents 3155:6e5bde0879ad
children 3157:8a870e0319db
files mod_pubsub_stats/README.markdown
diffstat 1 files changed, 13 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /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"
+```