Added v 0.2.0 snapshot.
[twitter4r-core.git] / README
blobfd0ad5f6d9b9f42cac11e5c5f72b198914c6858e
1 = Twitter4R
3 * Project Website - http://twitter4r.rubyforge.org
4 * Mailing List - http://groups.google.com/group/twitter4r-users
6 == Developers
7 * {Susan Potter}[http://SusanPotter.NET] <me at susanpotter dot net>
9 == Contributors
10 * Kaiichi Matsunaga <ma2 at lifemedia dot co dot jp>
12 == Description
13 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.
15 == External Dependencies
16 * Ruby 1.8 (tested with 1.8.5)
17 * RSpec gem 1.0.0+ (tested with 1.0.4)
18 * JSON gem 0.4.3+ (tested with versions: 0.4.3, and 0.1.1)
19 * jcode (for unicode support)
21 == Usage Examples
22 Twitter4R starting with version 0.1.1 and above is organized into seven parts:
23 * {Configuration API}[link:files/examples/configure_rb.html]
24 * {Friendship API}[link:files/examples/friendship_rb.html]
25 * {Messaging API}[link:files/examples/messaging_rb.html]
26 * {Model API}[link:files/examples/model_rb.html]
27 * {Status API}[link:files/examples/status_rb.html]
28 * {Timeline API}[link:files/examples/timeline_rb.html]
29 * {User API}[link:files/examples/user_rb.html]