From a8c9d944bde9aae2579be4143f0338335be50b8c Mon Sep 17 00:00:00 2001 From: Nick Parker Date: Sun, 20 Jun 2021 00:57:03 +1200 Subject: [PATCH] Add clarification around installing twitch-rss itself --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index eacbc26..0434708 100644 --- a/README.md +++ b/README.md @@ -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 \ -- 2.38.5