]> git.mxchange.org Git - friendica-addons.git/blobdiff - twitter/README
Merge remote branch 'upstream/master'
[friendica-addons.git] / twitter / README
index e6d5f12c9bc928d99e64a836cfe390de2c5ca653..ff08976c79613d98828d078c0b603c1c1f25158b 100755 (executable)
@@ -1,5 +1,6 @@
 ____ Twitter Plugin ____
 By Tobias Diekershoff
+   http://diekershoff.homeunix.net/friendika/profile/tobias
    tobias.diekershoff(at)gmx.net
 
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@@ -7,7 +8,7 @@ By Tobias Diekershoff
 !!   with it, please contact the Author.                                    !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
-With this addon to Friendika you can give your user the possibility to post
+With this addon to Friendica you can give your user the possibility to post
 their *public* messages to Twitter. The messages will be strapped their rich
 context and shortened to 140 characters length if necessary. If shortening of
 the message was performed a link will be added to the Tweet pointing to the
@@ -20,10 +21,13 @@ Online version of this document: http://ur1.ca/35mml
 
 ___ Requirements ___
 
-To use this plugin you have to register your Friendika 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.
@@ -34,7 +38,7 @@ message was longer than 140 characters requires it, that you have *PHP5+* and
 
 ___ Where to find ___
 
-In the Friendika git repository /addon/twitter/, this directory contains
+In the Friendica git repository /addon/twitter/, this directory contains
 all required PHP files (including the Twitter OAuth library [1] by Abraham
 Williams, MIT licensed and the Slinky library [2] by Beau Lebens, BSD license),
 a CSS file for styling of the user configuration and an image to _Sign in with
@@ -47,18 +51,31 @@ ___ Configuration ___
 
 __ Global Configuration __
 
+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 __
 
@@ -68,10 +85,11 @@ connect to Twitter. To do so one has to follow the _Sign in with Twitter_
 button (the page will be opened in a new browser window/tab) and get a PIN from
 Twitter. This PIN has to be entered on the settings page. After submitting the
 PIN the plugin will get OAuth credentials identifying this user from the
-Friendika account.
+Friendica account.
 
 If this first step was successful the Twitter configuration will be changed
 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.
 
+