README.rdoc in jamescallmebrent-rumblr-0.0.1 vs README.rdoc in jamescallmebrent-rumblr-0.0.2

- old
+ new

@@ -2,19 +2,15 @@ Rumblr is a Ruby client for http://www.tumblr.com XML API. It currently only provides read functionality; you can read User, Tumblelog and Post data. = Overview -Rumblr maps the Tumblr API 'authenticate' and 'read' calls. User, Tumblelog and Post models have attributes provided by the API, as well as some convenience methods for common tasks. +Rumblr maps the Tumblr API 'authenticate' and 'read' calls. User, Tumblelog and Post models have the attributes provided by the API, as well as some convenience methods for common tasks. -Please read Tumblr's official documentation (http://tumblr.com/api/) to learn more the API. +Please read Tumblr's official documentation (http://tumblr.com/api/) to learn more about the API. -== Dependencies -* Ruby >= 1.8.6 (not tested with previous versions) -* libxml-ruby >= 0.8.3 - == Dependencies * Ruby >= 1.8.6 (not tested with previous versions) * libxml-ruby >= 0.8.3 @@ -30,16 +26,17 @@ == Getting Started In order to use this library you need a valid Tumblr account. Go to http://tumblr.com and register for a new account if you don't already have one. + === Sample usage: require 'rumblr' include Rumblr - user = User.login({:email => 'brent.hargrave@gmail.com', :password => 'tumb198$'}) + user = User.login({:email => 'name@domain.com', :password => 'pass'}) user.tumblelogs.each do |log| puts log.name # 'the tumblelogger' puts log.type # 'public' puts log.url # 'http://tumblelogger.tumblr.com/' @@ -51,25 +48,11 @@ tumblelog.posts.each do |post| puts post.type # 'quote' puts post.url # 'http://tumblelogger.tumblr.com/post/12345/my-first-tumblr-post' end - -== Credits - -Author:: {Brent Hargrave}[http://brenthargrave.info/] <brent.hargrave@gmail.com> - -This library was inspired by some great Ruby clients for other webservices: {WWW::Delicious}[http://github.com/weppos/www-delicious/tree/master] and {dropio_api_ruby}[http://github.com/weppos/www-delicious/tree/master] - - -== Resources - -* {GitHub}[http://github.com/jamescallmebrent/rumblr/] - - -== FeedBack and Bug reports - -Please email {Brent Hargrave}[mailto:brent.hargrave@gmail.com] with any questions or feedback. + post = RegularPost.new(:title => "Post Title", :body => "Just a regular post!") + Client.instance.write(post, {:email => 'name@domain.com', :password => 'pass'}) == License Copyright (c) 2009 Brent Hargrave. Rumblr is released under the MIT license.