# HG changeset patch
# User Michael Töglhofer <michael@toeglhofer.net>
# Date 1444577008 -7200
# Node ID 392e62f518a5bd95bb1c847b6eefe385132cadf3
# Parent  41ebdb331b9475aed4d7f8aac55bc8f86c1852db
mod_s2s_keepalive: Add README

diff -r 41ebdb331b94 -r 392e62f518a5 mod_s2s_keepalive/README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_s2s_keepalive/README.markdown	Sun Oct 11 17:23:28 2015 +0200
@@ -0,0 +1,31 @@
+---
+summary: Keepalive s2s connections
+...
+
+Introduction
+============
+
+This module periodically sends XEP-0199 ping requests to remote servers
+to keep your connection alive.
+
+Configuration
+=============
+
+Simply add the module to the `modules_enabled` list and specify your
+desired servers in `keepalive_servers`. Optionally you can configure
+the ping interval.
+
+    modules_enabled = {
+        ...
+        "s2s_keepalive"
+    }
+
+    keepalive_servers = { "conference.prosody.im"; "rooms.swift.im" }
+    keepalive_interval = "300" -- (in seconds, default is 60 )
+
+Compatibility
+=============
+
+  ------- -----------------------
+  0.10    Works
+  ------- -----------------------