Files
RSSingle/Documentation/Usage.md
2022-06-25 14:30:37 -04:00

67 lines
1.1 KiB
Markdown

# Usage
<br>
1. Download the binary.
### Linux
``` shell
wget https://github.com/tanrax/RSSingle/releases/download/v1.0.0/rssingle
```
<br>
### MacOS / Windows
*Coming soon*
<br>
<br>
2. Gives execution permissions.
``` shell
chmod +x rssingle
```
<br>
<br>
3. In the same directory as the binary, you can <br>
create a local `config.yml` file in this format:
``` yaml
title: My RSS Feed
description: My customised RSS feed with technology news
url: https://www.example.com
output: rss.xml
feeds:
- https://programadorwebvalencia.com/feed/
- https://republicaweb.es/feed/
```
If not, you can download the **[Example]** in the repository.
``` shell
curl -o config.yml https://raw.githubusercontent.com/tanrax/RSSingle/master/config.yml
```
<br>
<br>
4. Run the binary.
``` shell
./rssingle
```
A file called `rss.xml` will be created.
<br>
<!----------------------------------------------------------------------------->
[Example]: ../Source/config.yml