README.rdoc in rakumarket-0.1.0 vs README.rdoc in rakumarket-0.2.0
- old
+ new
@@ -1,29 +1,30 @@
= Rakumarket {<img src="https://secure.travis-ci.org/bonsaiben/rakumarket.png">}[http://travis-ci.org/bonsaiben/rakumarket] {<img src="https://gemnasium.com/bonsaiben/rakumarket.png">}[https://gemnasium.com/bonsaiben/rakumarket]
A reader-friendly Ruby abstraction of the Rakuten Market API.
+See the {Github page}[http://bonsaiben.github.com/rakumarket] for detailed usage information.
+
== Description
The goal was to abstract Rakuten's complex API away from users and provide a simpler, easier-to-read Ruby interface in its place.
== Features
* Idiomatic Ruby
* Simpler and more readable representation of the underlying API
* Well-tested
-* Returns Hashie::Mash[https://github.com/intridea/hashie]
+* Concrete classes and methods
== Goals
* Completeness
* More simplerer
* Better-tested
-* Concrete classes and methods?
== Installation
@@ -39,35 +40,35 @@
== Basic Usage
Please see the wiki for a more comprehensive documentation.
-=== {Item Search}[https://github.com/bonsaiben/rakumarket/wiki/Item-Search]
+=== Item Search
- Rakumarket.item_search "roomba", options
+ Rakumarket.item_search "roomba", :price => {:maximum => 30000}
-=== {Genre Search}[https://github.com/bonsaiben/rakumarket/wiki/Genre-Search]
+=== Item Lookup
+ Rakumarket.item_lookup "act-corp:10000580"
+
+=== Genre Search
+
Rakumarket.genre_search
+=== Item Ranking
+ Rakumarket.item_ranking :sex => :male, :age_range => (20..29)
+
== Todo
* remaining APIs
* RDoc markup
-== Dependencies
-* HTTParty[https://github.com/jnunemaker/httparty]
-* Hashie::Mash[https://github.com/intridea/hashie]
-
-
-
-
== License
(The MIT License)
Copyright (c) 2012 Benjamin Sullivan
@@ -92,6 +93,6 @@
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
== Credit
-Rakumarket is inspired by multiple other Ruby API wrappers including groupon[https://github.com/pengwynn/groupon] and facebooker[https://github.com/mmangino/facebooker].
+Rakumarket is inspired by multiple other Ruby API wrappers including instagram[https://github.com/mislav/instagram], groupon[https://github.com/pengwynn/groupon] and facebooker[https://github.com/mmangino/facebooker].