Endless loop nesting on ensureHub failure now fixed

[quix0rs-gnu-social.git] / plugins / Orbited / README

diff --git a/plugins/Orbited/README b/plugins/Orbited/README
index 4abd40af7ae18bbb3e350559ac7d2ab1fd888e46..20d0598e24e7d25bdb64656db72c291453aa2c82 100644 (file)
--- a/plugins/Orbited/README
+++ b/plugins/Orbited/README
@@ -1,26 +1,37 @@
-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.
+The Orbited plugin enables "real time" updates using Orbited + STOMP
 
-NOTE: this is an insecure version; don't roll it out on a production
-server.
+See:
+* https://pypi.python.org/pypi/orbited
+* https://en.wikipedia.org/wiki/Streaming_Text_Oriented_Messaging_Protocol
 
-It requires a cometd server. I've only had the cometd-java server work
-correctly; something's wiggy with the Twisted-based server.
+Installation
+============
+add "addPlugin('Orbited');"
+to the bottom of your config.php
 
-After you have a cometd server installed, just add this code to your
-config.php:
+Settings
+========
+webserver:
+webport:
+channelbase:
+stompserver:
+stompport:
+username:
+password:
+webuser:
+webpass:
 
-    require_once(INSTALLDIR.'/plugins/Comet/CometPlugin.php');
-    $cp = new CometPlugin('http://example.com:8080/cometd/');
+Example
+=======
+addPlugin('Orbited', array(
+    'webserver' => '',
+    'webport' => '',
+    'channelbase' => '',
+    'stompserver' => '',
+    'stompport' => '',
+    'username' => '',
+    'password' => '',
+    'webuser' => '',
+    'webpass' => ''
+));
 
-Change 'example.com:8080' to the name and port of the server you
-installed cometd on.
-
-TODO:
-
-* Needs to be tested with Ajax submission. Probably messes everything
-  up.
-* Add more timelines: personal inbox and tags would be great.
-* Add security. In particular, only let the PHP code publish notices
-  to the cometd server. Currently, it doesn't try to authenticate.