# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1371053530 -7200
# Node ID ce55e811637bcdccda49c81eef688d1b41724f2b
# Parent  4a39ef28e2d91aad4b98754b194b8c3e06772cae
Add an actual description

diff -r 4a39ef28e2d9 -r ce55e811637b mod_pubsub_feeds.wiki
--- a/mod_pubsub_feeds.wiki	Wed Jun 12 18:01:46 2013 +0200
+++ b/mod_pubsub_feeds.wiki	Wed Jun 12 18:12:10 2013 +0200
@@ -1,1 +1,31 @@
-This module implements a [http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html PubSubHubbub] subscriber, which stores data in [http://xmpp.org/extensions/xep-0060.html Publish-Subscribe] nodes with mod_pubsub.
+#summary Subscribe to Atom and RSS feeds over pubsub
+
+= Introduction =
+
+This module allows Prosody to fetch Atom and RSS feeds for you, and push new results to subscribers over XMPP.
+
+This module also implements a [http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html PubSubHubbub] subscriber, allowing updates be delivered without polling for supporting feed publishers.
+
+= Configuration =
+
+This module must be loaded on a Prosody pubsub component. Add it to `modules_enabled` and configure like so:
+
+{{{
+Component "pubsub.example.com" "pubsub"
+    modules_enabled = { "pubsub_feeds" }
+    
+    feeds = {
+			planet_jabber = "http://planet.jabber.org/atom.xml";
+			prosody_blog = "http://blog.prosody.im/feed/atom.xml";
+		}
+}}}
+
+This example creates two nodes, 'planet_jabber' and 'prosody_blog' that clients can subscribe to using [http://xmpp.org/extensions/xep-0060.html XEP-0060]. Results are in [http://atomenabled.org/ ATOM 1.0 format] for easy consumption.
+
+|| *Option* || *Description* ||
+|| feeds || A list of virtual nodes to create and their associated Atom or RSS URL. ||
+|| feed_pull_interval || Number of minutes between polling for new results (default 15) ||
+|| use_pubsubhubub || If PubSubHubbub should be enabled, true by default. ||
+
+= Compatibility =
+|| 0.9 || Works ||