twitter/README.md

   1 Twitter Addon
   2 ==============
   3
   4 Main authors Tobias Diekershoff, Michael Vogel and Hypolite Petovan.
   5
   6 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.
   7
   8 ## Installation
   9
  10 To use this addon you have to register an [application](https://apps.twitter.com/) for your Friendica instance on Twitter.
  11 Register your Friendica site as "Client" application with "Read & Write" access we do not need "Twitter as login".
  12 Please leave the field "Callback URL" empty.
  13 When you've registered the app you get the OAuth Consumer key and secret pair for your application/site.
  14
  15 After the registration please enter the values for "Consumer Key" and "Consumer Secret" in the [administration](admin/addons/twitter).
  16
  17 ## Alternative configuration
  18
  19 Open the `config/local.config.php` file and add "twitter" to the list of activated addons:
  20
  21     'system' => [
  22         ...
  23         'addon' => '...,twitter'
  24         ...
  25     ]
  26
  27 Add your key pair to your global `config/addon.config.php`.
  28
  29         'twitter' => [
  30                 'consumerkey' => 'your consumer_key here',
  31                 'consumersecret' => 'your consumer_secret here',
  32         ],
  33
  34 After this, users can configure their Twitter account settings from "Settings -> Addon Settings".
  35
  36 ## License
  37
  38 The _Twitter Connector_ is licensed under the [3-clause BSD license][2] see the LICENSE file in the addons directory.
  39
  40 The _Twitter Connector_ uses the [Twitter OAuth library][2] by Abraham Williams, MIT licensed
  41
  42 [1]: http://opensource.org/licenses/BSD-3-Clause
  43 [2]: https://github.com/abraham/twitteroauth