mod_muc_badge/README.markdown
changeset 3146 feefc29a1ef4
parent 3145 774845606d73
child 3147 1f0d269a7cf0
--- a/mod_muc_badge/README.markdown	Sat Jun 23 18:08:34 2018 +0200
+++ b/mod_muc_badge/README.markdown	Sat Jun 23 18:12:54 2018 +0200
@@ -9,8 +9,12 @@
 
 # Introduction
 
-This module generates a badge, similar the one
-<https://opkode.com/blog/xmpp-chat-badge/>
+This module generates a badge at a HTTP URL like
+`https://example.com:5281/muc_badge/roo@conference.example.org`
+containing the number of occupants.
+
+Inspiration
+:   <https://opkode.com/blog/xmpp-chat-badge/>
 
 # Configuration
 
@@ -23,3 +27,6 @@
 The template must be valid XML. If it contains `{label}` then this is
 replaced by `badge_label`, similarly, `{count}` is substituted by
 `badge_count` with `%d` changed to the number of occupants.
+
+Details of the HTTP URL is determined by [standard Prosody HTTP server
+configuration][doc:http].