README.md in omniauth-eventbrite-0.0.5 vs README.md in omniauth-eventbrite-0.0.6
- old
+ new
@@ -1,9 +1,14 @@
# OmniAuth Eventbrite
-This gem contains the Eventbrite strategy for OmniAuth 1.0.
+This gem contains the Eventbrite strategy for OmniAuth 2.0.
+*Notice*: Versions 0.0.1 through 0.0.5 use Eventbrite API v1, which is due to
+be deprecated within two months of 2015-04-30. Versions after that will use
+Eventbrite API v3. This will affect the user_id that you get back from the API
+but your auth_token should remain the same.
+
## Installing
Add to your `Gemfile`:
```ruby
@@ -19,9 +24,25 @@
provider :eventbrite, ENV['EVENTBRITE_CLIENT_ID'], ENV['EVENTBRITE_CLIENT_SECRET']
end
```
You can find your client secret on the same page where your application API key is.
+
+## Referral Program Code
+
+If you participate in the [Eventbrite Referral Program][referral], you can also
+include your referral code as a parameter in all of your OAuth2 authentications
+by including it in the builder block:
+
+```ruby
+use OmniAuth::Builder do
+ provider :eventbrite, ENV['EVENTBRITE_CLIENT_ID'],
+ ENV['EVENTBRITE_CLIENT_SECRET'],
+ ref: 'EVENTBRITE_REFERRAL_CODE'
+end
+```
+
+[referral]: https://www.eventbrite.com/referral-program/
## License
Copyright (c) 2012 Kruttik Aggarwal