1
Fork 0
steam-rss/README.md

53 lines
1.7 KiB
Markdown
Raw Normal View History

2022-09-23 12:23:32 +00:00
# Steam ❤️ RSS
2022-09-21 13:48:49 +00:00
> **Get RSS feeds for Steam games.**
2022-09-23 12:23:32 +00:00
## Features
* 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.
2022-09-23 12:28:31 +00:00
## Installation
### Cargo
With a working [Rust and Cargo](https://www.rust-lang.org/learn/get-started) installation, you can install `steam-rss` from [Crates.io](https://crates.io/crates/steam-rss).
```
cargo install steam-rss
```
### Binaries
2022-09-23 12:23:32 +00:00
Precompiled `x86_64-unknown-linux-gnu` binaries are available on the [Releases page](https://git.bauke.xyz/Bauke/steam-rss/releases).
2022-09-23 12:33:07 +00:00
## Usage
```
USAGE:
steam-rss [OPTIONS]
OPTIONS:
-a, --appid <APPID> A game's AppID, can be used multiple times
-h, --help Print help information
--opml Output the feeds as OPML
-t, --timeout <TIMEOUT> The time in milliseconds to sleep between HTTP requests [default:
250]
--url <URL> A game's store URL, can be used multiple times
--user <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
```
2022-09-23 12:23:32 +00:00
## 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.