# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1452017983 -3600
# Node ID e3e76e9693a1dd7424f6a1f343192bfc618f4435
# Parent  7c16e0199a0679245f70211bc83beaef515720a7
mod_s2soutinjection: Add a README

diff -r 7c16e0199a06 -r e3e76e9693a1 mod_s2soutinjection/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_s2soutinjection/README.markdown	Tue Jan 05 19:19:43 2016 +0100
@@ -0,0 +1,30 @@
+---
+summary: S2S connection override
+...
+
+# Introduction
+
+This module is similar to [mod\_srvinjection] but less of an hack.
+
+# Configuration
+
+``` lua
+-- In the global section
+
+modules_enabled = {
+    --- your other modules
+    "s2soutinjection";
+}
+
+s2s_connect_overrides = {
+    -- This one will use the default port, 5269
+    ["example.com"] = "xmpp.server.local";
+
+    -- To set a different port:
+    ["another.example"] = { "non-standard-port.example", 9999 };
+}
+```
+
+# Compatibility
+
+Requires 0.9.x or later.