Redo the readme.
This commit is contained in:
parent
94bfc41ade
commit
002b2e2d1f
35
README.md
35
README.md
|
@ -1,25 +1,22 @@
|
||||||
# Steam RSS
|
# Steam ❤️ RSS
|
||||||
|
|
||||||
> **Get RSS feeds for Steam games.**
|
> **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.
|
||||||
|
|
||||||
```
|
## Binaries
|
||||||
USAGE:
|
|
||||||
steam-rss [OPTIONS]
|
|
||||||
|
|
||||||
OPTIONS:
|
Precompiled `x86_64-unknown-linux-gnu` binaries are available on the [Releases page](https://git.bauke.xyz/Bauke/steam-rss/releases).
|
||||||
-a, --appid <APPID> A game's AppID, can be used multiple times
|
|
||||||
-h, --help Print help information
|
## Feedback
|
||||||
--opml Output the feeds as OPML
|
|
||||||
-t, --timeout <TIMEOUT> The time in milliseconds to sleep between HTTP requests [default:
|
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.
|
||||||
250]
|
|
||||||
--url <URL> A game's store URL, can be used multiple times
|
## License
|
||||||
--user <USER> A person's steamcommunity.com ID or full URL, can be used multiple
|
|
||||||
times
|
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.
|
||||||
-v, --verify Verify potential feeds by downloading them and checking if they
|
|
||||||
return XML
|
|
||||||
-V, --version Print version information
|
|
||||||
```
|
|
||||||
|
|
Loading…
Reference in New Issue