From 002b2e2d1faa52b283e56da2d9e171dad06053a8 Mon Sep 17 00:00:00 2001 From: Bauke Date: Fri, 23 Sep 2022 14:23:32 +0200 Subject: [PATCH] Redo the readme. --- README.md | 35 ++++++++++++++++------------------- 1 file changed, 16 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 6ceb1c9..8855b05 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,22 @@ -# Steam RSS +# Steam ❤️ RSS > **Get RSS feeds for Steam games.** -*AGPL-3.0-or-later* +## Features -## `--help` +* Get RSS feeds from a game's AppID or store page. +* Get RSS feeds for all games from a user profile. +* Verify potential feeds by checking if they return `text/xml`. +* Output feeds as an OPML file for easy importing. -``` -USAGE: - steam-rss [OPTIONS] +## Binaries -OPTIONS: - -a, --appid A game's AppID, can be used multiple times - -h, --help Print help information - --opml Output the feeds as OPML - -t, --timeout The time in milliseconds to sleep between HTTP requests [default: - 250] - --url A game's store URL, can be used multiple times - --user A person's steamcommunity.com ID or full URL, can be used multiple - times - -v, --verify Verify potential feeds by downloading them and checking if they - return XML - -V, --version Print version information -``` +Precompiled `x86_64-unknown-linux-gnu` binaries are available on the [Releases page](https://git.bauke.xyz/Bauke/steam-rss/releases). + +## Feedback + +Found a problem or want to request a new feature? Email [me@bauke.xyz](mailto:me@bauke.xyz) and I'll see what I can do for you. + +## License + +Distributed under the [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html) license, see [LICENSE](LICENSE) for more information.