annotate mod_pubsub_stats/README.markdown @ 3422:ba3c79ef2253

lint: Teach luacheck about the new module:send_iq API
author Kim Alvefur <zash@zash.se>
date Wed, 02 Jan 2019 10:49:43 +0100
parents 1900280e2a90
children f1a63271dcfc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3409
1900280e2a90 mod_pubsub_stats/README: Link to docs for Prosodys statistics
Kim Alvefur <zash@zash.se>
parents: 3156
diff changeset
1 This module publishes data from [Prosody's `internal` statistics][doc:statistics]
1900280e2a90 mod_pubsub_stats/README: Link to docs for Prosodys statistics
Kim Alvefur <zash@zash.se>
parents: 3156
diff changeset
2 into a PubSub node in [XEP-0039] format.
3156
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 The node defaults to `stats` but can be changed with the option
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 `pubsub_stats_node`.
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 ``` lua
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 Component "pubsub.example.com" "pubsub"
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 modules_enabled = {
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 "pubsub_stats";
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 }
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 pubsub_stats_node = "statistics"
50618747e00e mod_pubsub_stats: Add a brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 ```