# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1534789363 -7200
# Node ID 2b888a7aa21cb89252f64e8d0cf64a4b01c77b74
# Parent  ca856a8927195fefd7c110d41cf769bd3d49cdf2
mod_pubsub_text_interface: Add a README

diff -r ca856a892719 -r 2b888a7aa21c mod_pubsub_text_interface/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_pubsub_text_interface/README.markdown	Mon Aug 20 20:22:43 2018 +0200
@@ -0,0 +1,27 @@
+# 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