Mercurial > prosody-modules
comparison mod_pubsub_text_interface/README.markdown @ 3244:2b888a7aa21c
mod_pubsub_text_interface: Add a README
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Mon, 20 Aug 2018 20:22:43 +0200 |
| parents | |
| children | a0e0ec729aab |
comparison
equal
deleted
inserted
replaced
| 3243:ca856a892719 | 3244:2b888a7aa21c |
|---|---|
| 1 # Introduction | |
| 2 | |
| 3 This module lets you manage subscriptions to pubsub nodes via simple | |
| 4 chat messages. Subscriptions are always added based on bare JID. The | |
| 5 `include_body` flag is enabled so that a plain text body version of events | |
| 6 can be included, where supported. | |
| 7 | |
| 8 # Configuring | |
| 9 | |
| 10 ```lua | |
| 11 Component "pubsub.example.com" "pubub" | |
| 12 modules_enabled = { | |
| 13 "pubsub_text_interface", | |
| 14 } | |
| 15 ``` | |
| 16 | |
| 17 # Commands | |
| 18 | |
| 19 The following commands are supported. Simply send a normal chat message | |
| 20 to the PubSub component where this module is enabled. When subscribing | |
| 21 or unsubscribing, be sure to replace `node` with the node you want to | |
| 22 subscribe to or unsubscribe from. | |
| 23 | |
| 24 - `help` - a help message, listing these commands | |
| 25 - `list` - list available nodes | |
| 26 - `subscribe node` - subscribe to a node | |
| 27 - `unsubscribe node` - unsubscribe from a node |