# HG changeset patch
# User JC Brand <jc@opkode.com>
# Date 1609350294 -3600
# Node ID 149ec3abf09ebca8e5d4fea987eaaaa0c3d6b67d
# Parent  fc5c53d9d34091a326830998fdeb0ed5cfc375a8
mod_muc_mention_notifications: Add description in readme

and document incompatibility with mod_block_strangers

diff -r fc5c53d9d340 -r 149ec3abf09e mod_muc_mention_notifications/README.markdown
--- a/mod_muc_mention_notifications/README.markdown	Wed Dec 30 16:44:21 2020 +0100
+++ b/mod_muc_mention_notifications/README.markdown	Wed Dec 30 18:44:54 2020 +0100
@@ -1,5 +1,13 @@
 # Configuring
 
+This module lets Prosody notify users when they're mentioned in a MUC, even if they're not currently present in it.
+
+Users need to be explicitly mentioned via XEP-0372 references.
+
+In anonymous and semi-anonymous rooms, the mentioned user needs to have their nickname registered in the MUC so that Prosody can get the real JID from the referenced nickname.
+
+NOTE: this module is not compatible with mod_block_strangers because the latter will block the notification messages from the MUC (since they're not "groupchat" messages).
+
 ## Enabling
 
 ``` {.lua}