# HG changeset patch
# User Michael Vetter <jubalh@openmailbox.org>
# Date 1480116845 -3600
# Node ID bd3a1df128a4e038a9e789f14563f038c83e2f8e
# Parent  913bd81a4d3c1965d428ba8f459c62ebe0ef9799
Add documentation for mod_block_outgoing

diff -r 913bd81a4d3c -r bd3a1df128a4 mod_block_outgoing/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_block_outgoing/README.markdown	Sat Nov 26 00:34:05 2016 +0100
@@ -0,0 +1,28 @@
+---
+summary: 'Block outgoing stanzas from users'
+...
+
+Introduction
+============
+
+This module blocks all outgoing stanzas from a list of users.
+
+Using
+=====
+
+Add mod_block_outgoing to the enabled modules in your config file:
+``` {.lua}
+modules_enabled = {
+	-- ...
+		"block_outgoing",
+	-- ...
+}
+```
+
+Either in a section for a certain host or the global section define which users and what stanzas to block:
+``` {.lua}
+block_outgoing_users = { "romeo@example.com", "juliet@example.com" }
+block_outgoing_stanzas = { "message", "iq", "presence" }
+```
+
+block_outgoing_stanzas defaults to "message" if not specified.