docs: add info about force script

This commit is contained in:
2018-10-19 13:08:14 -07:00
parent def91e35d3
commit eb4666c3df

View File

@@ -7,7 +7,9 @@ Action bot for Github. Checks a repo's event stream and leaves a ghost comment w
## Usage
`node . owner/repo`
`yarn start owner/repo`: watch the event stream and handle matches
`yarn run force owner/repo pr_number`: force a comment on a specific pr, by number
You'll need to set some environment flags. Check `sample-env` for what is available, and you can copy the file to `.env` in the root and add your settings there as well.
@@ -17,4 +19,4 @@ You will need to provide a Github [Personal Access Token](https://github.com/set
#### License
MIT © [w33ble](https://github.com/w33ble)
MIT © [w33ble](https://github.com/w33ble)