README

   1 = Twitter4R
   2
   3 * Project Website - http://twitter4r.rubyforge.org
   4 * Mailing List - http://groups.google.com/group/twitter4r-users
   5
   6 == Developers
   7 * {Susan Potter}[http://SusanPotter.NET] <me at susanpotter dot net>
   8
   9 == Contributors
  10 Code:
  11 * Kaiichi Matsunaga <ma2 at lifemedia dot co dot jp> - proxy code suggestion
  12 * Sergio Santos <> - message paging code suggestion
  13 * Adam Stiles <adam at stilesoft dot com> - URI.encode => CGI.escape fix
  14 * Carl Crawley <cwcrawley at gmail dot com> - Friendship get => post fix
  15 * Christian Johansen <christian at cjohansen dot no> - in_reply_to attributes in Twitter::Status
  16 * Harry Love <harrylove at gmail dot com> - added attributes to Twitter::Status
  17 * Filipe Giusti <filipegiusti at gmail dot com> - fixed users/show issue that Twitter.com changed from under us, also inspired the v0.5.2 bugfix release by submitting great issue example code.
  18 * Seth Cousins <seth.cousins at gmail dot com> - added HTTP timeout option and provided a patch that inspired the OAuth support for Twitter4R
  19 * John McKerrell <@mcknut on twitter> - added geo attribute to Twitter::Message.
  20
  21 Design Suggestions:
  22 * Bosco So <rubymeetup at boscoso dot com> - making Twitter::Error a RuntimeError instead of an Exception to prevent irb from crashing out.
  23
  24 == Description
  25 Twitter4R provides an object based API to query or update your Twitter account via pure Ruby.  It hides the ugly HTTP/REST code from your code.
  26
  27 == External Dependencies
  28 * Ruby 1.8 (tested with 1.8.6)
  29 * RSpec gem 1.0.0+ (tested with 1.1.3)
  30 * JSON gem 0.4.3+ (tested with versions: 1.1.1 and 1.1.2)
  31 * jcode (for unicode support)
  32
  33 == Usage Examples
  34 Twitter4R starting with version 0.1.1 and above is organized into seven parts:
  35 * {Configuration API}[link:files/examples/configure_rb.html]
  36 * {Friendship API}[link:files/examples/friendship_rb.html]
  37 * {Messaging API}[link:files/examples/messaging_rb.html]
  38 * {Model API}[link:files/examples/model_rb.html]
  39 * {Status API}[link:files/examples/status_rb.html]
  40 * {Timeline API}[link:files/examples/timeline_rb.html]
  41 * {User API}[link:files/examples/user_rb.html]