From fcdb97f07939855536ad1533903e60d0486be349 Mon Sep 17 00:00:00 2001 From: Nazar Kanaev Date: Fri, 5 Mar 2021 15:29:47 +0000 Subject: [PATCH] update docs --- doc/todo.txt | 3 --- readme.md | 8 +++++--- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/doc/todo.txt b/doc/todo.txt index 3c7abe6..4057112 100644 --- a/doc/todo.txt +++ b/doc/todo.txt @@ -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/ diff --git a/readme.md b/readme.md index 67f2a43..a639106 100644 --- a/readme.md +++ b/readme.md @@ -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: