Merge branch '0.9.x' into private-rss

1 files changed, 27 insertions, 0 deletions

diff --git a/plugins/Meteor/README b/plugins/Meteor/README
new file mode 100644
index 000000000..22f548462
--- /dev/null
+++ b/plugins/Meteor/README
@@ -0,0 +1,27 @@
+This is a plugin to automatically load notices in the browser no
+matter who creates them -- the kind of thing we see with
+search.twitter.com, rejaw.com, or FriendFeed's "real time" news.
+
+It requires a meteor server.
+
+   http://meteorserver.org/
+
+Note that the controller interface needs to be accessible by the Web
+server, and the subscriber interface needs to be accessible by your
+Web users. You MUST firewall the controller interface from users;
+otherwise anyone will be able to push any message to your subscribers.
+Not good!
+
+You can enable the plugin with this line in config.php:
+
+addPlugin('Meteor', array('webserver' => 'meteor server address'));
+
+Available parameters:
+
+* webserver: Web server address. Defaults to site server.
+* webport: port to connect to for Web access. Defaults to 4670.
+* controlserver: Control server address. Defaults to webserver.
+* controlport: port to connect to for control. Defaults to 4671.
+* channelbase: a base string to use for channels. Good if you have
+  multiple sites using the same meteor server.
+