diff mod_muc_rtbl/README.md @ 6306:093c47ee2041

mod_muc_rtbl: Simplify configuration and tweak docs
author Matthew Wild <mwild1@gmail.com>
date Thu, 31 Jul 2025 15:43:41 +0100
parents 6e2458b69e33
children 4c788f8be94e
line wrap: on
line diff
--- a/mod_muc_rtbl/README.md	Thu Jul 31 15:12:51 2025 +0100
+++ b/mod_muc_rtbl/README.md	Thu Jul 31 15:43:41 2025 +0100
@@ -23,21 +23,26 @@
 }
 ```
 
-Then you should configure one or more lists you want to subscribe to:
+Then you should configure one or more lists you want to subscribe to, supplying
+full or partial URIs (the default node is 'muc_bans_sha256' if unspecified):
 
 ```lua
 muc_rtbls = {
+	"rtbl.example";
+	-- Equivalent to above
 	"xmpp:rtbl.example?;node=muc_bans_sha256";
 }
 ```
 
-If an unaffiliated JID matches an entry found in any of the configured lists,
+If an unaffiliated JID matches an entry found in any of the configured RTBLs,
 this module will block:
 
 - Joins
 - Group chat messages
 - Private messages
 
+from the JID that matched.
+
 # Compatibility
 
 Should work with Prosody >= 0.12.x