extensions/TweetPosts/README

   1 =========================================================================================================
   2
   3 Tweet Posts is an extension for Vanilla designed for Tweeting discussions.
   4
   5 See it in action at http://forums.sixlabrats.com
   6
   7
   8 * NOTE: This extension is in beta and it should not be used in a production environment *
   9
  10
  11
  12 Tweet Posts By John Croucher - www.sixlabrats.com www.jcroucher.com
  13 Twitter Library Copyright (c) 2007, Jaisen Mathai - see TwitterLib/LICENCE
  14
  15 =========================================================================================================
  16                                     EXTENSION SETUP INSTRUCTIONS
  17 =========================================================================================================
  18
  19 TeetPosts for security reasons uses oAuth to connect to Twitter.
  20 For this reason there is a bit of setup involved to get this extension to work.
  21
  22 01. Create a twitter application
  23          This can be done by going to http://twitter.com/oauth_clients and following the prompts.
  24
  25          1.1 Set the application type to "Browser"
  26          1.2 Set the application callback url to http://YOUR_DOMAIN/settings.php?PostBackAction=ProcessTweetPosts
  27
  28 02. Take note of the Consumer Key and Consumer Secret which are generated
  29
  30 03. Install the TweetPosts plugin
  31
  32 04. Go to settings -> Tweet Posts Settings
  33
  34 05. Place your Consumer Key and Consumer Secret key in the appropriate boxes
  35
  36 06. Select Save
  37          You will now be redirected to Twitter
  38
  39 07. Enter in your username and password on twitter for the account you want the tweets to go to
  40
  41 08. Select approve application
  42          You will now be redirected back to your forum settings
  43          All fields should now be filled in and saved.
  44
  45 09. Test by creating a new discussion and check your twitter account
  46
  47 10. The twitter message can be edited in default.php on line 158. This will be editable through settings
  48     in a future version.
  49
  50 =========================================================================================================
  51                                  EXTENSION INSTALLATION INSTRUCTIONS
  52 =========================================================================================================
  53
  54 In order for Vanilla to recognize an extension, it must be contained within its
  55 own directory within the extensions directory. So, once you have downloaded and
  56 unzipped the extension files, you can then place the folder containing the
  57 default.php file into your installation of Vanilla. The path to your extension's
  58 default.php file should look like this:
  59
  60 /path/to/vanilla/extensions/TweetPosts/default.php
  61
  62 Once this is complete, you can enable the extension through the "Manage
  63 Extensions" form on the settings tab in Vanilla.
  64
  65 =========================================================================================================
  66
  67 To Do:
  68 - Investigate if there is a better way to hook into the post. I am interested in any input for better methods
  69 - More error handling
  70 - Code tidy up
  71 - Allow the Tweet message format to be edited through the settings
  72
  73
  74 =========================================================================================================
  75
  76 CHANGELOG
  77
  78 v0.01 - Initial Beta Release