"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 5a48869007148fa3610e5fae4b8c9fcf4ab47185..f1f875415229330cc0a575737f403b217f6d1dc7 100644 (file)
--- a/twitter/README.md
+++ b/twitter/README.md
@@ -3,16 +3,36 @@ Twitter Addon
 
 Main authors Tobias Diekershoff, Michael Vogel and Hypolite Petovan.
 
-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.
+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.
 
 ## 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.
 
 After the registration please enter the values for "Consumer Key" and "Consumer Secret" in the [administration](admin/addons/twitter).
 
+## Alternative configuration
+
+Open the `config/local.config.php` file and add "twitter" to the list of activated addons:
+
+    'system' => [
+        ...
+        'addon' => '...,twitter'
+        ...
+    ]
+
+Add your key pair to your global `config/addon.config.php`.
+
+       'twitter' => [
+               'consumerkey' => 'your consumer_key here',
+               'consumersecret' => 'your consumer_secret here',
+       ],
+
+After this, users can configure their Twitter account settings from "Settings -> Addon Settings".
+
 ## License
 
 The _Twitter Connector_ is licensed under the [3-clause BSD license][2] see the LICENSE file in the addons directory.