# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1554242595 -7200
# Node ID c1d7e6752d18dc52a5fe36f332c26c4adbaf9505
# Parent  7893115bf382a80205a305e993c74000839f21b7
mod_csi_muc_priorities: Add a README

diff -r 7893115bf382 -r c1d7e6752d18 mod_csi_muc_priorities/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_csi_muc_priorities/README.markdown	Wed Apr 03 00:03:15 2019 +0200
@@ -0,0 +1,22 @@
+# Introduction
+
+This module lets users specify which of the group chats they are in are
+less important. This influences when
+[mod_csi_simple][doc:modules:mod_csi_simple] decides to send
+stanzas vs waiting until there is more to send. Users in many large
+public channels might benefit from this.
+
+# Configuration
+
+The module is configured via ad-hoc an command called *Configure group
+chat priorities* that should appear in the menus of compatible clients.
+
+The command presents a form that accepts a list of XMPP addresses.
+Currently there is a single priority, *Lower priority*, which is
+suitable for e.g. noisy public channels. mod_csi_simple considers
+groupchat messages important by default on the assumptions that smaller
+and more important private chats are more common among most users.
+
+A message of type groupchat from an address in this list will not be
+considered important enough to send it to an inactive client, unless it
+is from the current user or mentions their nickname.