README.md in omniauth-facebook-4.0.0.rc1 vs README.md in omniauth-facebook-4.0.0
- old
+ new
@@ -2,11 +2,11 @@
**These notes are based on master, please see tags for README pertaining to specific releases.**
Facebook OAuth2 Strategy for OmniAuth.
-Supports the OAuth 2.0 server-side and client-side flows. Read the Facebook docs for more details: http://developers.facebook.com/docs/authentication
+Supports OAuth 2.0 server-side and client-side flows. Read the Facebook docs for more details: http://developers.facebook.com/docs/authentication
## Installing
Add to your `Gemfile`:
@@ -47,25 +47,25 @@
For example, to request `email`, `user_birthday` and `read_stream` permissions and display the authentication page in a popup window:
```ruby
Rails.application.config.middleware.use OmniAuth::Builder do
- provider :facebook, ENV['FACEBOOK_KEY'], ENV['FACEBOOK_SECRET'],
- scope: 'email,user_birthday,read_stream', display: 'popup'
+ provider :facebook, ENV['APP_ID'], ENV['APP_SECRET'],
+ scope: 'email,user_birthday,read_stream', display: 'popup'
end
```
### API Version
-OmniAuth Facebook uses versioned API endpoints by default (current v2.6). You can configure a different version via `client_options` hash passed to `provider`. For example:
+OmniAuth Facebook uses versioned API endpoints by default (current v2.6). You can configure a different version via `client_options` hash passed to `provider`, specifically you should change the version in the `site` and `authorize_url` parameters. For example, to change to v3.0 (assuming that exists):
```ruby
use OmniAuth::Builder do
provider :facebook, ENV['APP_ID'], ENV['APP_SECRET'],
client_options: {
- site: 'https://graph.facebook.com/v2.6',
- authorize_url: "https://www.facebook.com/v2.6/dialog/oauth"
+ site: 'https://graph.facebook.com/v3.0',
+ authorize_url: "https://www.facebook.com/v3.0/dialog/oauth"
}
end
```
### Per-Request Options
@@ -107,10 +107,11 @@
gender: 'male',
email: 'joe@bloggs.com',
timezone: -8,
locale: 'en_US',
verified: true,
- updated_time: '2011-11-11T06:21:03+0000'
+ updated_time: '2011-11-11T06:21:03+0000',
+ # ...
}
}
}
```