Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit b157f41

Browse files
authoredFeb 25, 2018
Update README.md
1 parent 31d9681 commit b157f41

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed
 

‎README.md

+19-7
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,26 @@
11
# slackoverflow
22
A Slack bot for your stackoverflow needs.
33

4-
## Features
4+
# Table of Contents
5+
1. [Features](#features)
6+
2. [Integration](#integration)
7+
3. [Usage](#usage)
8+
4. [Development](#development)
9+
5. [Contributing](#contributing)
10+
6. [Contributors](#contributors)
11+
7. [License](#license)
12+
13+
## Features <a name="features"></a>
514
* Pulls the top answer of the most relevant question matching your query.
615

7-
## Integration
16+
## Integration <a name="integration"></a>
817
Head over to http://adamhe.me/slack-bots/ and click on the `Add to Slack` button to add slackoverflow into your team!
918

10-
## Usage
19+
## Usage <a name="usage"></a>
1120
* Open Slack, either browser or desktop.
1221
* In any channel, mention the bot along with a question that you want to ask on stackoverflow, e.g `@slackoverflow how does a es6 promise work?` You can also direct message the bot directly if you don't want to clutter a channel.
1322

14-
## Development
23+
## Development <a name="development"></a>
1524
1. Create an app on slack.
1625
2. Obtain your api token.
1726
3. Add your api token into your environment as `SLACK_API_TOKEN`.
@@ -20,8 +29,11 @@ Head over to http://adamhe.me/slack-bots/ and click on the `Add to Slack` button
2029
6. Add the bot into any Slack teams (most likely one that you made for testing/developing).
2130
7. Run the bot via `python slackoverflow.py` and have fun developing!
2231

23-
## Contributor Guide
24-
[CONTRIBUTING Guide](https://github.com/ygongdev/slackoverflow/blob/master/CONTRIBUTING.md)
32+
## Contributing <a name="contributing"></a>
33+
[Contributing Guide](https://github.com/ygongdev/slackoverflow/blob/master/CONTRIBUTING.md)
34+
35+
## Contributors <a name="contributors"></a>
36+
[Contribuors](https://github.com/ygongdev/slackoverflow/blob/master/CONTRIBUTORS.md)
2537

26-
## License
38+
## License <a name="license"></a>
2739
[MIT License](https://github.com/ygongdev/slackoverflow/blob/master/LICENSE.md)

0 commit comments

Comments
 (0)
Please sign in to comment.