Update README.md

This commit is contained in:
Andros Fenollosa 2021-07-06 22:26:44 +02:00 committed by GitHub
parent aa64f3baf7
commit eaeb3b0415
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 43 additions and 2 deletions

View File

@ -5,12 +5,53 @@
<a href="https://rsspaper.andros.dev/">👉 DEMO 👈</a>
</p>
## Usage
## Run
1) Make sure you have Java installed.
Debian/Ubuntu
``` sh
sudo apt install default-jre
```
Mac OS
``` sh
brew install java
```
2) 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.
``` yaml
title: RSSPaper
# Options: light or dark
theme: light
# Options: daily, weekly or all
edition: weekly
feeds:
- https://programadorwebvalencia.com/feed/
- https://republicaweb.es/feed/
```
3) Download the latest version of RSSpaper (`rsspaper-{version}-standalone.jar`).
https://github.com/tanrax/RSSpaper/releases
4) Now you can execute glosa.
```sh
lein run
java -jar rsspaper-{version}-standalone.jar
```
Great 🎉. You already have your 🔥 own Static RSS Newspaper 🔥.
That's it, now you just have to open `dist/index.html`.
## Testing
``` sh