Skip to content

Document the startup procedure #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
phillipj merged 1 commit into from
Apr 7, 2016
Merged

Document the startup procedure #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
MIT

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view