--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_pubsub_twitter/README.wiki	Mon Aug 24 16:43:56 2015 +0200
@@ -0,0 +1,30 @@
+#summary Subscribe to Twitter search queries over pubsub
+#labels Stage-Alpha
+
+= Introduction =
+
+Twitter has an open 'realtime' search API, but it requires polling (within their rate limits). This module allows Prosody to poll for you, and push new results to subscribers over XMPP.
+
+= 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_twitter" }
+
+    twitter_searches = {
+        realtime = "xmpp OR realtime";
+        prosody = "prosody xmpp";
+    }
+}}}
+
+This example creates two nodes, 'realtime' and 'prosody' 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* ||
+|| twitter_searches || A list of virtual nodes to create and their associated Twitter search queries. ||
+|| twitter_pull_interval || Number of minutes between polling for new results (default 20) ||
+|| twitter_search_url || URL of the JSON search API, default: "http://search.twitter.com/search.json" ||
+
+= Compatibility =
+|| 0.9 || Works ||
\ No newline at end of file