changeset 380:0f832ed3fbd1

mod_pubsub_hub.wiki: Improve introduction and add config example
author Kim Alvefur <zash@zash.se>
date Sat, 29 Jun 2013 22:53:18 +0200
parents 6530cf806e20
children a21acacc8b22
files mod_pubsub_hub.wiki
diffstat 1 files changed, 27 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/mod_pubsub_hub.wiki	Sat Jun 29 22:51:55 2013 +0200
+++ b/mod_pubsub_hub.wiki	Sat Jun 29 22:53:18 2013 +0200
@@ -1,2 +1,28 @@
-This module implements a [http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html PubSubHubbub] hub, relays [http://xmpp.org/extensions/xep-0060.html Publish-Subscribe] nodes from mod_pubsub.
+#summary PubSubHubbub service
+
+= Introduction =
+
+This module implements a
+[http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html PubSubHubbub]
+(PuSH) hub, allowing PuSH clients to subscribe to local XMPP
+[http://xmpp.org/extensions/xep-0060.html Publish-Subscribe] nodes stored by
+[http://prosody.im/doc/modules/mod_pubsub mod_pubsub].
+
+= Configuration =
 
+{{{
+Component "pubsub.example.com" "pubsub"
+
+	modules_enabled = {
+		"pubsub_hub";
+	}
+
+}}}
+
+The hub is then available on {http://pubsub.example.com:5280/hub}.
+
+= Compatibility =
+
+||trunk||Works||
+||0.9||Works||
+||0.8||Doesn't work||