diff --git a/README.md b/README.md index bd703ca2..8cd0a1c9 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,26 @@ What's this?? ATM an experiment to see if a bot could be helpful for the Node.js project, to automate all the things! +## Get it started + +It's required to have a [GitHub API token](https://github.com/blog/1509-personal-api-tokens) and [Travis token](https://blog.travis-ci.com/2013-01-28-token-token-token/) before starting the bot. + +```bash +$ GITHUB_TOKEN=X TRAVIS_CI_TOKEN=Z npm start +``` + +### Create a GitHub access token + +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. + +### Retrieving your Travis token + +Your Travis token is visible on [your profile](https://travis-ci.org/profile) page, by clicking the "show token" link. + ## Contributing Please do, contributions are more than welcome! ## License -MIT \ No newline at end of file +MIT