Skip to content

Commit

Permalink
Update readme for team option.
Browse files Browse the repository at this point in the history
  • Loading branch information
kmrshntr committed May 9, 2015
1 parent acf3570 commit fdff681
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Slack lets you choose from a [few different scopes](https://api.slack.com/docs/o

## Authentication Options

#### State
### State

> *unique string to be passed back upon completion*
Expand All @@ -74,6 +74,18 @@ class CallbackController < ApplicationController
end
```

### Team

> If you don't pass a team param, the user will be allowed to choose which team they are authenticating against. Passing this param ensures the user will auth against an account on that particular team.
If you need to ensure that the users use the team whose team_id is 'XXXXXXXX', you can do so by passing `:team` option in your `config/initializers/omniauth.rb` like this:

```ruby
Rails.application.config.middleware.use OmniAuth::Builder do
provider :slack, "API_KEY", "API_SECRET", scope: "identify,read,post", team: 'XXXXXXXX'
end
```

## Contributing

1. Fork it
Expand All @@ -84,4 +96,3 @@ end


[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/kmrshntr/omniauth-slack/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

2 changes: 1 addition & 1 deletion lib/omniauth-slack/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
module Omniauth
module Slack
VERSION = "1.0.1"
VERSION = "2.0.0"
end
end

0 comments on commit fdff681

Please sign in to comment.