Mercurial > prosody-modules

diff mod_muc_ping/README.markdown @ 3356:31e113823463

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_ping: Add more details to README
author Kim Alvefur <zash@zash.se>
date Tue, 09 Oct 2018 16:47:27 +0200
parents 35dc7c38e362
children 861ddc74edd9
line wrap: on
line diff
--- a/mod_muc_ping/README.markdown	Tue Oct 09 14:12:45 2018 +0100
+++ b/mod_muc_ping/README.markdown	Tue Oct 09 16:47:27 2018 +0200
@@ -2,4 +2,23 @@
 Optimization](https://xmpp.org/extensions/xep-0410.html#serveroptimization)
 part of [XEP-0410: MUC Self-Ping]
 
+# Usage
+
+The module is loaded on MUC components:
+
+```lua
+Component "muc.example.com" "muc"
+modules_enabled = {
+    "muc_ping";
+}
+```
+
+# Configuration
+
+No options.
+
+# Compatibility
+
 It should work with Prosody up until 0.10.x.
+
+Prosody trunk natively supports XEP-0410 so this module is not needed.