Merge remote branch 'upstream/master'

[friendica-addons.git] / twitter / README

diff --git a/twitter/README b/twitter/README
index 9d52a47460f398f2720d794fd5ec2d13b3d00895..ff08976c79613d98828d078c0b603c1c1f25158b 100755 (executable)
--- a/twitter/README
+++ b/twitter/README
@@ -1,5 +1,6 @@
 ____ Twitter Plugin ____
 By Tobias Diekershoff
+   http://diekershoff.homeunix.net/friendika/profile/tobias
    tobias.diekershoff(at)gmx.net
 
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@@ -20,10 +21,13 @@ Online version of this document: http://ur1.ca/35mml
 
 ___ Requirements ___
 
-To use this plugin you have to register your Friendica instance as an
-_client application_ for Twitter with _read and write_ access, we do not intend
-to use Twitter for login. The registration can be done at twitter.com/apps
-and you need to have a Twitter account to do so.
+To use this plugin you have to register an application for your friendica
+instance on Twitter with
+  * read and write access
+  * don't set a callback URL
+  * we do not intend to use Twitter for login
+The registration can be done at twitter.com/apps and you need a Twitter
+account for doing so.
 
 After you registered the application you get an OAuth consumer key / secret
 pair that identifies your app, you will need them for configuration.
@@ -47,21 +51,31 @@ ___ Configuration ___
 
 __ Global Configuration __
 
-If you enabled an administrator account, please use the admin panel to cofigure
-the Twitter reley.
+If you enabled an administrator account, please use the admin panel to configure
+the Twitter relay. If you for any reason prefer to use a configuration file instead 
+of the admin panels, please refer to the Alternative Configuration below. 
+
+Activate the plugin from the plugins section of your admin panel.  When you have
+done so, add your consumer key and consumer secret in the settings section of the 
+plugin page.
+
+When this is done your user can now configure their Twitter connection at
+"Settings -> Connector Settings" and enable the forwarding of their *public*
+messages to Twitter.
+
+__ Alternative Configuration __
 
 To activate this addon add @twitter@ to the list of active addons in your
 .htconfig.php file 
-    $a->config['system']['addon'] = "twitter, ..."
+
+$a->config['system']['addon'] = "twitter, ..."
+
 Afterwards you need to add your OAuth consumer key / secret pair to it by
 adding the following two lines
 
 $a->config['twitter']['consumerkey'] = 'your consumer KEY here';
 $a->config['twitter']['consumersecret'] = 'your consumer SECRET here';
 
-When this is done your user can now configure their Twitter connection at
-"Settings -> Plugin Settings" and enable the forwarding of their *public*
-messages to Twitter.
 
 __ User Configuration __
 
@@ -78,3 +92,4 @@ on the "Plugin Settings" page displaying two check boxes. One to enable/disable
 the forwarding of *all public* postings to Twitter and one to clear the
 personal configuration from the Twitter credentials.
 
+