# HG changeset patch
# User Marco Cirillo <maranda@lightwitch.org>
# Date 1325892544 0
# Node ID ec2b94f02b3169483b635b5b3214f92eded15007
# Parent  1da94ec1f03055dcb7e8e8f48709fd0f8fdb1159
added wiki.

diff -r 1da94ec1f030 -r ec2b94f02b31 mod_xml_status.wiki
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_xml_status.wiki	Fri Jan 06 23:29:04 2012 +0000
@@ -0,0 +1,23 @@
+#summary XML server status plugin
+#labels Stage-Beta
+
+= Introduction =
+
+This module fetches the current status of configured hosts and/or stanza statistics from [http://code.google.com/p/prosody-modules/wiki/mod_stanza_counter#mod_stanza_counter].
+
+= Usage =
+
+Copy the file into prosody's module directory and place it into your global's enabled modules.
+
+Configuration example:
+{{{
+xml_status_http_ports = {{ port = 5280, path = "mystatsbasepath" }}
+xml_status_show_hosts = { "iwanttoshowifthishostisonline.com", "iwanttoshowifthishostisonline2.com" }
+xml_status_show_comps = { "muc.iwanttoshowifthishostisonline.com", "transport.iwanttoshowifthishostisonline.com" }
+}}}
+
+if mod_stanza_counter isn't loaded the plugin will require at least either xml_status_show_hosts or xml_status_show_comps to be set
+
+= Compatibility =
+
+ * 0.8+ Works.