update docs

This commit is contained in:
Nazar Kanaev 2021-03-05 15:29:47 +00:00
parent f2994bc6d0
commit fcdb97f079
2 changed files with 5 additions and 6 deletions

View File

@ -1,4 +1 @@
- fix: broken base link in https://applieddivinitystudies.com/
- fix: loading items (by scrolling down) is glitching while feeds are refreshing
- doc: self-hosting instructions (including certificates)
- etc: test gofeed against real-world feeds, compare results with https://pypi.org/project/feedparser/

View File

@ -1,7 +1,7 @@
# yarr
**yarr** (yet another rss reader) is a web-based feed aggregator which can be used both
as a desktop application and a self-hosted server.
as a desktop application and a personal self-hosted server.
It is written in Go with the frontend in Vue.js. The storage is backed by SQLite.
@ -33,14 +33,14 @@ but might only gently warn you about that, which you can safely ignore.
### linux
The Linux version doesn't come with the desktop environment integration.
For easy access you can manually create a desktop menu entry by
For easy access on DE it is recommended to create a desktop menu entry by
by following the steps below:
unzip -x yarr*.zip
sudo mv yarr /usr/local/bin/yarr
sudo nano /usr/local/share/applications/yarr.desktop
and paste the content:
and pasting the content:
[Desktop Entry]
Name=yarr
@ -49,6 +49,8 @@ and paste the content:
Type=Application
Categories=Internet;
For self-hosting, see `yarr -h` for auth, tls & server configuration flags.
## build
Install `Go >= 1.16` and `gcc`. Get the source code: