Twitter: Write a README.

master
Valentin Lorentz 2012-07-29 13:08:24 +00:00
parent 5c599b6fcb
commit c805bf2cdc
1 changed files with 27 additions and 1 deletions

View File

@ -1 +1,27 @@
Insert a description of your plugin here, with any notes, etc. about using it.
Advanced Twitter plugin for Supybot, with capabilities handling, and
per-channel user account.
Ever noticed a text "sent from web" or "sent via Android" under a tweet?
This is called the consumer. You have two choices:
* Keep the default consumer. This is the easier way; and the text will
be "sent via Supybot // Limnoria".
* Create your own consumer at https://dev.twitter.com/ . If you choosed
this way, you will have to set supybot.plugins.Twitter.consumer.key
and supybot.plugins.Twitter.secret with the consumer key/secret given
by Twitter.
Now, you have to set the accounts credentials (called access token)
for every channel you want to associate with a Twitter account.
If you use the default consumer, it is easy : just run the get_access_token.py
script provided with this plugin.
Otherwise, you will have either to edit the script with your own consumer
key/secret and run it, or get the token from dev.twitter.com.
Once you got the token key/secret, set it _as a channel-specific variable_
to supybot.plugins.Twitter.accounts.channel.key and
supybot.plugins.Twitter.accounts.channel.secret.