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
  17 Design Suggestions:
  18 * Bosco So <rubymeetup at boscoso dot com> - making Twitter::Error a RuntimeError instead of an Exception to prevent irb from crashing out.
  19
  20 == Description
  21 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.
  22
  23 == External Dependencies
  24 * Ruby 1.8 (tested with 1.8.6)
  25 * RSpec gem 1.0.0+ (tested with 1.1.3)
  26 * JSON gem 0.4.3+ (tested with versions: 1.1.1 and 1.1.2)
  27 * jcode (for unicode support)
  28
  29 == Usage Examples
  30 Twitter4R starting with version 0.1.1 and above is organized into seven parts:
  31 * {Configuration API}[link:files/examples/configure_rb.html]
  32 * {Friendship API}[link:files/examples/friendship_rb.html]
  33 * {Messaging API}[link:files/examples/messaging_rb.html]
  34 * {Model API}[link:files/examples/model_rb.html]
  35 * {Status API}[link:files/examples/status_rb.html]
  36 * {Timeline API}[link:files/examples/timeline_rb.html]
  37 * {User API}[link:files/examples/user_rb.html]