Merge remote-tracking branch 'statusnet/180' into statusnet_1.1.x

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

diff --git a/plugins/TwitterBridge/README b/plugins/TwitterBridge/README
index a386989b7a555f27f830ac67617e5d8ba04dc2ad..cb3369d1d09ce190680940186a574872b8f17fb2 100644 (file)
--- a/plugins/TwitterBridge/README
+++ b/plugins/TwitterBridge/README
@@ -1,3 +1,6 @@
+Twitter Bridge Plugin
+=====================
+
 This Twitter "bridge" plugin allows you to integrate your StatusNet
 instance with Twitter.  Installing it will allow your users to:
 
@@ -17,7 +20,7 @@ on Twitter (http://twitter.com/apps).  During the application
 registration process your application will be assigned a "consumer" key
 and secret, which the plugin will use to make OAuth requests to Twitter.
 You can either pass the consumer key and secret in when you enable the
-plugin, or set it using the Twitter administration panel.
+plugin, or set it using the Twitter administration panel**.
 
 When registering your application with Twitter set the type to "Browser"
 and your Callback URL to:
@@ -39,37 +42,56 @@ To enable the plugin, add the following to your config.php:
         )
     );
 
+or just:
+
+   addPlugin('TwitterBridge');
+
+if you want to set the consumer key and secret from the Twitter bridge
+administration panel.  (The Twitter bridge wont work at all
+unless you configure it with a consumer key and secret.)
+
 * Note: The plugin will still push notices to Twitter for users who
   have previously set up the Twitter bridge using their Twitter name and
   password under an older version of StatusNet, but all new Twitter
   bridge connections will use OAuth.
 
-Admin panel
------------
+** For multi-site setups you can also set a global consumer key and
+   secret.  The Twitter bridge will fall back on the global key pair if
+   it can't find a local pair, e.g.:
+
+   $config['twitter']['global_consumer_key']    = 'YOUR_CONSUMER_KEY';
+   $config['twitter']['global_consumer_secret'] = 'YOUR_CONSUMER_SECRET';
+
+Upgrade
+-------
+
+If you've used the Twitter bridge plugin prior to version 0.9.5,
+you'll need to run the new scripts/initialize_notice_to_status.php
+script to initialize the new notice-to-status mapping file, which
+greatly improves the integration between StatusNet and Twitter.
+
+Administration panel
+--------------------
 
 As of StatusNet 0.9.0 there is a new administration panel that allows
 you to configure Twitter bridge settings within StatusNet itself,
-instead of having to specify them manually in your config.php.  To enable
-the administration panel, you will need to add it to the list of active
-administration panels.  You can do this via your config.php. E.g.:
-
-    $config['admin']['panels'][] = 'twitter';
+instead of having to specify them manually in your config.php.
 
-And to access it, you'll need to use a user with the "administrator"
+To access it, you'll need to use a user with the "administrator"
 role (see: scripts/userrole.php).
 
 Sign in with Twitter
 --------------------
 
-As of 0.9.0 you StatusNet optionally allows users to register and
+With 0.9.0, StatusNet optionally allows users to register and
 authenticate using their Twitter credentials via the "Sign in with
 Twitter" pattern described here:
 
     http://apiwiki.twitter.com/Sign-in-with-Twitter
 
 The option is _on_ by default when you install the plugin, but it can
-disabled via the Twitter bridge admin panel, or by adding the following
-line to your config.php:
+disabled via the Twitter bridge administration panel, or by adding the
+following line to your config.php:
 
     $config['twitter']['signin'] = false;
 
@@ -119,9 +141,9 @@ set up Twitter bridging.
 
 It's not strictly necessary to run this queue handler, and sites that
 haven't enabled queuing are still able to push notices to Twitter, but
-for larger sites and sites that wish to improve performance, this script
+for larger sites and sites that wish to improve performance the script
 allows notices to be sent "offline" via a separate process.
 
 StatusNet will automatically use the TwitterQueueHandler if you have
-enabled the queuing system.  See the "Queues and daemons" section of the
-main README file for more information about how to do that.
+enabled the queuing subsystem.  See the "Queues and daemons" section of
+the main README file for more information about how to do that.