view mod_pubsub_text_interface/README.markdown @ 3410:a0e0ec729aab

mod_pubsub_text_interface/README: Normalize Markdown syntax
author Kim Alvefur <zash@zash.se>
date Sat, 22 Dec 2018 18:53:48 +0100
parents 2b888a7aa21c
children c479e39ff547
line wrap: on
line source

# Introduction

This module lets you manage subscriptions to pubsub nodes via simple
chat messages. Subscriptions are always added based on bare JID. The
`include_body` flag is enabled so that a plain text body version of
events can be included, where supported.

# Configuring

``` {.lua}
Component "pubsub.example.com" "pubub"
modules_enabled = {
    "pubsub_text_interface",
}
```

# Commands

The following commands are supported. Simply send a normal chat message
to the PubSub component where this module is enabled. When subscribing
or unsubscribing, be sure to replace `node` with the node you want to
subscribe to or unsubscribe from.

-   `help` - a help message, listing these commands
-   `list` - list available nodes
-   `subscribe node` - subscribe to a node
-   `unsubscribe node` - unsubscribe from a node