Commit f39ec1ee authored by Shawn Tabrizi's avatar Shawn Tabrizi
Browse files

Update README.md

parent 2a4e06df
# substrate-tip-bot
> A GitHub App built with [Probot](https://github.com/probot/probot) that A GitHub bot to submit tips on behalf of the network.
> A GitHub App built with [Probot](https://github.com/probot/probot) that can submit tips on behalf
> of a [Substrate](https://github.com/paritytech/substrate) based network.
## Setup
......@@ -12,6 +13,25 @@ npm install
npm start
```
### ENV File
To use this bot, you need to have a proper `.env` file created. Most of the options will
automatically be generated by the GitHub application creation process, but you will also need to add
`ACCOUNT_SEED` and `ALLOWED_USERS`:
Example `.env` file:
```
WEBHOOK_PROXY_URL=https://smee.io/<secret>
APP_ID=<id>
PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n private key \n-----END RSA PRIVATE KEY-----\n"
WEBHOOK_SECRET=<secret>
GITHUB_CLIENT_ID=<id>
GITHUB_CLIENT_SECRET=<secret>
ACCOUNT_SEED="twelve words seperated by spaces which seeds the account controlled by bot"
ALLOWED_USERS=["shawntabrizi", "and", "other", "github", "usernames", "in", "an", "array"]
```
## Docker
```sh
......@@ -24,10 +44,11 @@ docker run -e APP_ID=<app-id> -e PRIVATE_KEY=<pem-value> substrate-tip-bot
## Contributing
If you have suggestions for how substrate-tip-bot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
If you have suggestions for how substrate-tip-bot could be improved, or want to report a bug, open
an issue! We'd love all and any contributions.
For more, check out the [Contributing Guide](CONTRIBUTING.md).
## License
[ISC](LICENSE) © 2021 Shawn Tabrizi <shawntabrizi@gmail.com>
[MIT](LICENSE) © 2021 Shawn Tabrizi <shawntabrizi@gmail.com>
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment