From 346ef610fa695ead1bdfd28d3e7e03a01b528a06 Mon Sep 17 00:00:00 2001 From: Nick Parker Date: Sun, 20 Jun 2021 00:46:37 +1200 Subject: [PATCH] Tidy up readme, clarify some parts --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fe66d9b..eacbc26 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,30 @@ # Twitch-RSS -Generates RSS feeds for Twitch accounts +Generates RSS feeds for Twitch accounts. + +This acts as a proxy to Twitch, presenting video history as an RSS feed. The idea is that you can add specific accounts to your RSS reader as separate URLs/feeds. + +You can run it in two modes: +- HTTP: A caching proxy to Twitch, presenting an HTTP endpoint that can be added to RSS readers +- CLI: Manual polling (without caching), the resulting feed can be published to a static site. ## Quickstart +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. + ### HTTP -1. Create a [Twitch App](https://dev.twitch.tv/console/apps/create), then get the Client ID and Client Secret. -2. Start `twitch-rss` in server mode with `CLIENT_ID` and `CLIENT_SECRET` envvars containing the Twitch App credentials. `LISTEN` is optional, `0.0.0.0:8080` is the default: +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 \ CLIENT_SECRET=5678...efgh \ - LISTEN=0.0.0.0:8080 \ + LISTEN=127.0.0.1:8080 \ ./twitch-rss ``` -3. Add `twitch-rss` URL(s) to your RSS reader (e.g. [`miniflux`](https://miniflux.app)), or test manually with `curl`: +2. Add `twitch-rss` URL(s) to your RSS reader (e.g. [`miniflux`](https://miniflux.app)), or test manually with `curl`: ``` -$ curl -v 'http://localhost:8080/rss?account=ACCOUNT_NAME_HERE' +$ curl -v 'http://127.0.0.1:8080/rss?account=ACCOUNT_NAME_HERE' ``` ### CLI/stdout @@ -28,3 +36,7 @@ $ CLIENT_ID=1234...abcd \ CLIENT_SECRET=5678...efgh \ ./twitch-rss ACCOUNT_NAME_HERE ``` + +## License + +This project is [licensed](LICENCE.md) under the [FAFOL](https://git.sr.ht/~boringcactus/fafol/tree/master/README.md). This is intended to restrict use of the project for purposes that would be considered unethical by its authors. -- 2.38.5