# HG changeset patch
# User Waqas Hussain <waqas20@gmail.com>
# Date 1301701958 -18000
# Node ID e613d82d097aa2e5caac01523f3405c524362013
# Parent  5bbdbce10b0a0b086ad76aece7ffc037c1959955
mod_json_streams: Some documentation.

diff -r 5bbdbce10b0a -r e613d82d097a mod_json_streams.wiki
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_json_streams.wiki	Sat Apr 02 04:52:38 2011 +0500
@@ -0,0 +1,29 @@
+#summary JSON Encodings for XMPP
+#labels Stage-Beta
+
+= Introduction =
+
+This plugin encodes XMPP as JSON. This is an implementation of [http://xmpp.org/extensions/xep-0295.html XEP-0295: JSON Encodings for XMPP].
+
+Simply loading this modules makes Prosody accept JSON for C2S streams (legacy XML clients are still supported).
+
+For BOSH, it requires mod_bosh be loaded, and JSON should be directed to the '/jsonstreams' HTTP path.
+
+JSON for S2S isn't supported due to the lack of a discovery mechanism, so we have left that disabled to stay compatible with legacy XML servers).
+
+= Configuration =
+Just add json_streams in your global modules_enabled list, for example:
+
+{{{
+modules_enabled = {
+	...
+	"json_streams";
+}
+}}}
+
+= Compatibility =
+||0.8||Works||
+||trunk||Works||
+
+= Quirks =
+* This plugin does not work with TCP port multiplexing.