fix README for twitter plugin: typos + change to new menu structure

This commit is contained in:
Erkan Yilmaz 2011-09-02 07:07:03 +02:00
parent 71f71ecf46
commit 5a7934012c

View file

@ -3,7 +3,7 @@ By Tobias Diekershoff
tobias.diekershoff(at)gmx.net tobias.diekershoff(at)gmx.net
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This addon is currently in under development. If you have any problem !! !! This addon is currently under development. If you have any problem !!
!! with it, please contact the Author. !! !! with it, please contact the Author. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@ -29,7 +29,7 @@ After you registered the application you get an OAuth consumer key / secret
pair that identifies your app, you will need them for configuration. pair that identifies your app, you will need them for configuration.
The inclusion of a shorturl for the original posting in cases when the The inclusion of a shorturl for the original posting in cases when the
message was longer then 140 characters requires it, that you have *PHP5+* and message was longer than 140 characters requires it, that you have *PHP5+* and
*curl* on your server. *curl* on your server.
___ Where to find ___ ___ Where to find ___
@ -51,19 +51,19 @@ To activate this addon add @twitter@ to the list of active addons in your
.htconfig.php file .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 Afterwards you need to add your OAuth consumer key / secret pair to it by
adding the following to lines adding the following two lines
$a->config['twitter']['consumerkey'] = 'your consumer KEY here'; $a->config['twitter']['consumerkey'] = 'your consumer KEY here';
$a->config['twitter']['consumersecret'] = 'your consumer SECRET here'; $a->config['twitter']['consumersecret'] = 'your consumer SECRET here';
When this is done your user can now configure their Twitter connection at When this is done your user can now configure their Twitter connection at
"Settings -> Addon Settings" and enable the forwarding of their *public* "Settings -> Plugin Settings" and enable the forwarding of their *public*
messages to Twitter. messages to Twitter.
__ User Configuration __ __ User Configuration __
When the OAuth consumer informations are correctly placed into the When the OAuth consumer informations are correctly placed into the
configuration file and a user visits the "Addon Settings" page they can now configuration file and a user visits the "Plugin Settings" page they can now
connect to Twitter. To do so one has to follow the _Sign in with Twitter_ 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 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 Twitter. This PIN has to be entered on the settings page. After submitting the
@ -71,7 +71,7 @@ PIN the plugin will get OAuth credentials identifying this user from the
Friendika account. Friendika account.
If this first step was successful the Twitter configuration will be changed If this first step was successful the Twitter configuration will be changed
on the "Addon Settings" page displaying two check boxes. One to enable/disable 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 the forwarding of *all public* postings to Twitter and one to clear the
personal configuration from the Twitter credentials. personal configuration from the Twitter credentials.