README.md in omniauth-twitter-0.0.16 vs README.md in omniauth-twitter-0.0.17
- old
+ new
@@ -14,21 +14,27 @@
## Using This Strategy
First start by adding this gem to your Gemfile:
- gem 'omniauth-twitter'
+```ruby
+gem 'omniauth-twitter'
+```
If you need to use the latest HEAD version, you can do so with:
- gem 'omniauth-twitter', :github => 'arunagw/omniauth-twitter'
+```ruby
+gem 'omniauth-twitter', :github => 'arunagw/omniauth-twitter'
+```
Next, tell OmniAuth about this provider. For a Rails app, your `config/initializers/omniauth.rb` file should look like this:
- Rails.application.config.middleware.use OmniAuth::Builder do
- provider :twitter, "CONSUMER_KEY", "CONSUMER_SECRET"
- end
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+ provider :twitter, "CONSUMER_KEY", "CONSUMER_SECRET"
+end
+```
Replace CONSUMER_KEY and CONSUMER_SECRET with the appropriate values you obtained from dev.twitter.com earlier.
## Authentication Options
@@ -40,16 +46,16 @@
* **screen_name** - This option implies **force_login**, except the screen name field is pre-filled with a particular value. *Example:* `http://yoursite.com/auth/twitter?screen_name=jim`
* **x_auth_access_type** - This option (described [here](https://dev.twitter.com/docs/api/1/post/oauth/request_token)) lets you request the level of access that your app will have to the Twitter account in question. *Example:* `http://yoursite.com/auth/twitter?x_auth_access_type=read`
-* **use_authorize** - There are actually two URLs you can use against the Twitter API. As mentioned, the default is `https://api.twitter.com/oauth/authenticate`, but you also have `https://api.twitter.com/oauth/authorize`. Passing this option as `true` will use the second URL rather than the first. What's the difference? As described [here](https://dev.twitter.com/docs/api/1/get/oauth/authenticate), with `authenticate`, if your user has already granted permission to your application, Twitter will redirect straight back to your application, whereas `authorize` forces the user to go through the "grant permission" screen again. For certain use cases this may be necessary. *Example:* `http://yoursite.com/auth/twitter?use_authorize=true`
+* **use_authorize** - There are actually two URLs you can use against the Twitter API. As mentioned, the default is `https://api.twitter.com/oauth/authenticate`, but you also have `https://api.twitter.com/oauth/authorize`. Passing this option as `true` will use the second URL rather than the first. What's the difference? As described [here](https://dev.twitter.com/docs/api/1/get/oauth/authenticate), with `authenticate`, if your user has already granted permission to your application, Twitter will redirect straight back to your application, whereas `authorize` forces the user to go through the "grant permission" screen again. For certain use cases this may be necessary. *Example:* `http://yoursite.com/auth/twitter?use_authorize=true`. *Note:* You must have "Allow this application to be used to Sign in with Twitter" checked in [your application's settings](https://dev.twitter.com/apps) - without it your user will be asked to authorize your application each time they log in.
## Watch the RailsCast
Ryan Bates has put together an excellent RailsCast on OmniAuth:
-[](http://railscasts.com/episodes/241-simple-omniauth-revised)
+[](http://railscasts.com/episodes/241-simple-omniauth-revised)
## Supported Rubies
OmniAuth Twitter is tested under 1.8.7, 1.9.2, 1.9.3 and Ruby Enterprise Edition.