Skip to content

Commit e9a8114

Browse files
committed
Document the startup procedure
1 parent a18378f commit e9a8114

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,22 @@
22

33
What's this?? ATM an experiment to see if a bot could be helpful for the Node.js project, to automate all the things!
44

5+
## Get it started
6+
7+
It's required to have a [GitHub API token](https://github.com/blog/1509-personal-api-tokens) before starting the bot.
8+
9+
```bash
10+
$ GITHUB_TOKEN=X npm start
11+
```
12+
13+
### Create a GitHub access token
14+
15+
Go to your own profile settings page and [generate a personal access token](https://github.com/settings/tokens/new). After clicking the **Generate token** button you're presented with the token you should put in `$GITHUB_TOKEN` when starting the bot.
16+
517
## Contributing
618

719
Please do, contributions are more than welcome!
820

921
## License
1022

11-
MIT
23+
MIT

0 commit comments

Comments
 (0)