Skip to content

Commit 20d0a9d

Browse files
committed
Updated getting started instructions to OAuth v2 workflow.
1 parent 6992446 commit 20d0a9d

File tree

3 files changed

+8
-10
lines changed

3 files changed

+8
-10
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ bundle exec rake
2727

2828
### Run Examples in Development
2929

30-
Sign up for Slack, create a private slack group for yourself.
30+
Sign up for Slack, create a private Slack team for yourself, then [generate an API token](https://api.slack.com/tutorials/tracks/getting-a-token) for your app and use it for some interactions.
3131

32-
Create a new App under [https://api.slack.com/apps](https://api.slack.com/apps).
32+
Try running the examples in the [examples](examples) directory.
3333

34-
![](screenshots/create-app.png)
35-
36-
On the next screen, note the API token.
37-
38-
To run [the example in examples/hi_real_time_and_web](examples/hi_real_time_and_web/hi.rb), open a terminal, cd into _examples/hi_real_time_and_web_, run `bundle install`, followed by `SLACK_API_TOKEN=<your API token> bundle exec ruby hi.rb`.
34+
```bash
35+
cd examples/hi_web
36+
bundle install
37+
SLACK_API_TOKEN=... bundle exec ruby hi.rb
38+
```
3939

4040
## Contribute Code
4141

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,9 @@ Run `bundle install`.
105105

106106
To integrate your bot with Slack, you must first create a new [Slack App](https://api.slack.com/apps).
107107

108-
![](screenshots/create-app.png)
109-
110108
### OAuth Code Grant
111109

112-
Once created, go to the app's Basic Info tab and grab the Client ID and Client Secret. You'll need these in order complete an [OAuth code grant flow](https://api.slack.com/docs/oauth#flow) as described at [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server).
110+
Once created, go to the app's Basic Info tab and grab the Client ID and Client Secret. You'll need these in order complete an [OAuth Workflow](https://api.slack.com/authentication/oauth-v2). A working sample that starts a local web server and obtains a bot or a user token for your app using OAuth v2 is available in [examples/oauth_v2](examples/oauth_v2).
113111

114112
### Using an API Token
115113

screenshots/create-app.png

-85 KB
Binary file not shown.

0 commit comments

Comments
 (0)