Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nicktu12 committed Jan 7, 2019
1 parent e30c000 commit c388dea
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
# BeyBot

> A GitHub App built with [Probot](https://github.com/probot/probot) that A probot that worships Queen Beyoncé
> A GitHub App built with [Probot](https://github.com/probot/probot). All hail Queen Beyoncé.
## Setup

```sh
```
# Install dependencies
npm install
# Run the bot
npm start
```

This application accesses the [Giphy API](https://developers.giphy.com/) to generate GIFs. You will need to get an API key through Giphy's developer portal and add to the `.env` file of this project, with a key of `GIPHY` and value of the API key.

To add BeyBot to your Github, visit https://github.com/apps/beybot.

## Contributing

If you have suggestions for how BeyBot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
Expand All @@ -20,4 +24,4 @@ For more, check out the [Contributing Guide](CONTRIBUTING.md).

## License

[ISC](LICENSE) © 2018 Nick Teets <[email protected]>
[ISC](LICENSE) © 2019 [Nick Teets](https://github.com/nicktu12) <[email protected]>

0 comments on commit c388dea

Please sign in to comment.