README.md in etsy-0.3.0 vs README.md in etsy-0.3.1
- old
+ new
@@ -24,10 +24,36 @@
The gem has been verified to work with version 1.5.0 of json.
It will likely work with higher versions, but this is unproven.
## Usage
+In order to try this out you'll need to create an app on [etsy.com/your/apps](https://www.etsy.com/your/apps).
+
+This will give you an api key and secret.
+
+Paste the following into IRB, replacing the api key and secret with the ones you got on Etsy:
+
+```ruby
+require 'etsy'
+Etsy.protocol = "https"
+Etsy.api_key = 'YOUR API KEY'
+Etsy.api_secret = 'YOUR SECRET'
+request = Etsy.request_token
+Etsy.verification_url
+```
+
+Paste the verification URL into your browser, and authorize the application. That will give you a page
+with a code on it. Paste the following into IRB, replacing the code:
+
+```ruby
+access = Etsy.access_token(request.token, request.secret, 'CODE')
+Etsy.myself(access.token, access.secret)
+```
+
+If you've received a 401 unauthorized error, then you likely don't have a valid api key and secret, or
+perhaps the verification url timed out.
+
### Public Mode
The Etsy API has two modes: public, and authenticated. Public mode only requires an
API key (available from http://developer.etsy.com ):
@@ -65,10 +91,15 @@
Authenticated calls can now be made by passing an access token and secret:
Etsy.myself(access.token, access.secret)
+The key and secret have to be passed in for the authenticated calls.
+
+ auth = {:access_token=>access.token, :access_secret=>access.secret}
+ Etsy::Transaction.find_all_by_shop_id(shop_id, auth.merge(options))
+
### Web Application
The process for authenticating via a web application is similar, but requires the configuration of a callback URL:
require 'etsy'
@@ -276,19 +307,31 @@
## Contributors
These people have helped make the Etsy gem what it is today:
* [Patrick Reagan](https://github.com/reagent)
-* [Katrina Owen](http://github.com/kytrinyx)
+* [Katrina Owen](https://github.com/kytrinyx)
+* [Trae Robrock](https://github.com/trobrock)
+* [Roger Smith](https://github.com/rogsmith)
+* [Jimmy Tang](https://github.com/jimmytang)
* [Mak Nazečić-Andrlon](https://github.com/Muon)
+* [Daniel Szmulewicz](https://github.com/danielsz)
* [Patrick Schless](https://github.com/plainlystated)
+* [Martin Popelak](https://github.com/pupca)
+* [Julio Santos](https://github.com/julio)
* [Matt Fields](https://github.com/mfields106)
+* [Mike Taylor](https://github.com/sealabcore)
+* [Mason Stewart](https://github.com/masondesu)
+* [Sasha Gerrand](https://github.com/sgerrand)
* [Jake Boxer](https://github.com/jakeboxer)
-* [Trae Robrock](https://github.com/trobrock)
-* [Jimmy Tang](https://github.com/jimmytang)
-* [Julio Santos](https://github.com/julio)
-* [Roger Smith](https://github.com/rogsmith)
-* [Daniel Szmulewicz](https://github.com/danielsz)
+* [Sunwoo Yang](https://github.com/sunwooz)
+* [Isaac Rosenberg](https://github.com/irosenb)
+* [Carson Gross](https://github.com/carsongross)
+* [John Amicangelo](https://github.com/JohnAmican)
+* [Max Gulyaev](https://github.com/maxilev)
+* [fbehrens](https://github.com/fbehrens)
+* [William Jeffries](https://github.com/williamcodes)
+* [Jack Guoyuan Zhao](https://github.com/zhaoguoyuan)
### Github Flow
For those of you with commit access, please check out Scott Chacon's blog post about [github flow](http://scottchacon.com/2011/08/31/github-flow.html)