README.md in storenvy-0.0.2 vs README.md in storenvy-0.1.0
- old
+ new
@@ -1,29 +1,55 @@
The Storenvy Ruby Gem
====================
-A Ruby wrapper for the Storenvy REST API.
+A Ruby wrapper for the Storenvy REST API. Initial versions cover the read-only Public JSON API
Installation
------------
gem install storenvy
Usage
-------------
- client = Storenvy::Client.new
- store = client.store("tonkapark")
+ client = Storenvy::Client.new("tonkapark")
+ store = client.store
+ puts store.url
+ # GET First 50 Products for account
+ client.products()
+
+ # GET All Products
+ client.products(display_all_products = true)
+
+ # GET Single Page, max 50 products
+ client.products(page = 2)
+ # GET Single Product
+ client.product(12345)
+
+ # GET Collections
+ client.collections
+
+ # GET Single Collection
+ client.collection(12345)
+
+
Supported Rubies
----------------
* 1.8.7
* 1.9.2
Change Log
==========
+
+0.1.0 - August 3rd 2012
+--------------
+* Tweaked Client to take in the host/subdomain/account id from storenvy shop.
+* Added in new methods (products, product, all_products, collections, collection) for more of the public storenvy api
+* Added more tests
+
0.0.2 - August 2nd 2012
--------------
* just starting out.
\ No newline at end of file