RSSPAPER/README.md

43 lines
1.2 KiB
Markdown
Raw Normal View History

2021-07-06 16:20:41 -04:00
<h1 align="center">
2021-07-18 18:06:12 -04:00
<img alt="RSSpaper logo" src="resources/static/img/icons/default-alpha.png">
2021-07-06 16:20:41 -04:00
</h1>
2021-07-06 12:02:59 -04:00
<p align="center">
2021-07-19 18:24:32 -04:00
<a href="https://rsspaper.andros.dev/">👉 DEMO 👈</a> (My own feed generated daily with Github Actions)
2021-07-06 16:29:09 -04:00
</p>
2020-11-03 17:57:47 -05:00
2021-07-19 18:32:46 -04:00
Generate a static page with the latest news from your favorite feeds. Is it an RSS client? Yes, except that it generates an **HTML/PWA** that you can read or **install on your tablet or mobile** and to **update the news you must run it again**.
2021-07-06 16:26:44 -04:00
## Run
2021-07-19 18:24:32 -04:00
1) Create a file `config.yaml` with the following content. You can also use `config.yaml.example` as a base config and change it to fit your needs.
2021-07-06 16:26:44 -04:00
``` yaml
2021-07-19 18:26:05 -04:00
# Change the title, it's for you. Maybe you see "My newspaper"?
title: RSSPAPER
2021-07-06 16:26:44 -04:00
# Options: light or dark
theme: light
# Options: daily, weekly or all
edition: weekly
feeds:
- https://programadorwebvalencia.com/feed/
- https://republicaweb.es/feed/
```
2021-07-19 18:24:32 -04:00
2) Download the latest version of RSSpaper (`rsspaper-{version}-standalone.jar`).
2021-07-06 16:26:44 -04:00
2021-07-19 18:32:46 -04:00
https://github.com/tanrax/RSSPAPER/releases
2021-07-06 16:26:44 -04:00
2021-07-19 18:24:32 -04:00
3) Now you can execute.
2020-11-03 17:57:47 -05:00
2020-11-04 01:25:21 -05:00
```sh
2021-07-06 16:26:44 -04:00
java -jar rsspaper-{version}-standalone.jar
2020-11-04 01:25:21 -05:00
```
2020-11-03 17:57:47 -05:00
2021-07-06 19:07:59 -04:00
Great 🎉. You already have your 📰 own Static RSS Newspaper 📰.
2021-07-06 16:26:44 -04:00
That's it, now you just have to open `dist/index.html`.