"log" is replaced with the corresponding logging functions

[friendica-addons.git] / twitter / README.md

diff --git a/twitter/README.md b/twitter/README.md
index edfc81385ccf56ae4627cac4becc43795f71cc3e..f1f875415229330cc0a575737f403b217f6d1dc7 100644 (file)
--- a/twitter/README.md
+++ b/twitter/README.md
@@ -1,39 +1,43 @@
-Twitter Plugin
+Twitter Addon
 ==============
 
-Main authors Tobias Diekershoff and Michael Vogel.
+Main authors Tobias Diekershoff, Michael Vogel and Hypolite Petovan.
 
-With this addon to friendica you can give your users the possibility to post their *public* messages to Twitter and 
-to import their timeline. The messages will be strapped their rich context and shortened to 280 characters length if 
-necessary.
+This bi-directional connector addon allows each user to crosspost their Friendica public posts to Twitter, import their Twitter timeline, interact with tweets from Friendica, and crosspost to Friendica their public tweets.
 
-The addon can also mirror a users Tweets into the ~friendica wall.
+## Installation
 
-Installation
-------------
+To use this addon you have to register an [application](https://apps.twitter.com/) for your Friendica instance on Twitter.
+Register your Friendica site as "Client" application with "Read & Write" access we do not need "Twitter as login".
+Please leave the field "Callback URL" empty.
+When you've registered the app you get the OAuth Consumer key and secret pair for your application/site.
 
-To use this plugin you have to register an [application](https://apps.twitter.com/) for your friendica instance on Twitter. Please leave the field "Callback URL" empty.
+After the registration please enter the values for "Consumer Key" and "Consumer Secret" in the [administration](admin/addons/twitter).
 
-After the registration please enter the values for "Consumer Key" and "Consumer Secret" in the [administration](admin/plugins/twitter).
+## Alternative configuration
 
-Where to find
--------------
+Open the `config/local.config.php` file and add "twitter" to the list of activated addons:
 
-In the friendica addon git repository /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
-Twitter_.
+    'system' => [
+        ...
+        'addon' => '...,twitter'
+        ...
+    ]
 
-[1]: https://github.com/abraham/twitteroauth
-[2]: http://dentedreality.com.au/projects/slinky/
+Add your key pair to your global `config/addon.config.php`.
 
-License
-=======
+       'twitter' => [
+               'consumerkey' => 'your consumer_key here',
+               'consumersecret' => 'your consumer_secret here',
+       ],
 
-The _StatusNet Connector_ is licensed under the [3-clause BSD license][3] see the
-LICENSE file in the addons directory.
+After this, users can configure their Twitter account settings from "Settings -> Addon Settings".
 
-[3]: http://opensource.org/licenses/BSD-3-Clause
+## License
 
+The _Twitter Connector_ is licensed under the [3-clause BSD license][2] see the LICENSE file in the addons directory.
 
+The _Twitter Connector_ uses the [Twitter OAuth library][2] by Abraham Williams, MIT licensed
+
+[1]: http://opensource.org/licenses/BSD-3-Clause
+[2]: https://github.com/abraham/twitteroauth