From b280d832347358cad5ecc2828a64038c7ffff5ea Mon Sep 17 00:00:00 2001 From: Jeena Date: Sat, 21 Mar 2026 12:44:31 +0000 Subject: [PATCH] docs: add features list and river of news description to README --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 1406b29..c4bae82 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,20 @@ FeedTheMonkey is a desktop client for any server that implements the It doesn't work as a standalone feed reader — it connects to a server to fetch articles and sync read state. +It follows the [river of news](http://scripting.com/2014/06/02/whatIsARiverOfNewsAggregator.html) philosophy: all unread articles appear in a single flat list and are automatically marked as read as you flip through them one by one. + +## Features + +- **River of news**: all unread articles in one flat list, auto-marked as read as you flip through them one by one +- **Offline reading**: article content and images are cached locally so you can read without a connection +- **Image caching**: images are pre-fetched after each reload; skipped on metered connections unless enabled in preferences +- **Offline sync**: read/unread state changes made offline are queued and pushed to the server next time you're online +- **Persistent state**: the article list, selected article, and scroll position are restored when you reopen the app +- **Dark mode**: follows the system color scheme automatically +- **Keyboard navigation**: vi-style shortcuts for hands-free reading +- **Zoom**: adjustable content zoom, persisted across restarts +- **Fullscreen** and toggleable sidebar + When logging in, enter: - **FreshRSS**: `https://example.com/api/greader.php`