~nickbp/twitch-rss

a8c9d944bde9aae2579be4143f0338335be50b8c — Nick Parker 3 months ago 346ef61
Add clarification around installing twitch-rss itself
1 files changed, 3 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +3 -0
@@ 13,8 13,11 @@ You can run it in two modes:
In order to use this, you first need to create a [Twitch App](https://dev.twitch.tv/console/apps/create) and get the Client ID and Client Secret.
Those credentials will then be used by `twitch-rss` to query Twitch APIs.

To install `twitch-rss`, you can run `cargo install twitch-rss`. [Docker images](https://hub.docker.com/r/nickbp/twitch-rss/tags) for amd64/arm64 are also available, see the [Dockerfile](https://git.sr.ht/~nickbp/twitch-rss/tree/main/item/Dockerfile).

### HTTP

0. Prerequisites: Get your Twitch App credentials, and install `twitch-rss` using `cargo install twitch-rss`.
1. Start `twitch-rss` with `CLIENT_ID` and `CLIENT_SECRET` envvars containing the Twitch App credentials. You can optionally also specify `LISTEN`, `0.0.0.0:8080` is the default:
```
$ CLIENT_ID=1234...abcd \