Skip to content

Commit 8543b1c

Browse files
committed
update user documentation, remove clients that are no longer maintained
Signed-off-by: Benjamin Brahmer <info@b-brahmer.de>
1 parent c001367 commit 8543b1c

2 files changed

Lines changed: 58 additions & 14 deletions

File tree

docs/clients.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,35 @@
33
Clients are applications that use the REST API of News. They are not maintained by the News team.
44
If you are the developer of an app, feel free to create a PR to add your app to this list.
55

6+
## Recommended Clients
7+
8+
Based on activity and maintenance status we can recommend these clients:
9+
10+
- Android: [Nextcloud News Reader](https://play.google.com/store/apps/details?id=de.luhmer.owncloudnewsreader) (official Nextcloud News client)
11+
- Desktop (Windows/Linux/macOS): [RSS Guard](https://github.com/martinrotter/rssguard)
12+
- Terminal: [newsboat](https://newsboat.org/)
13+
614
## Sync Clients
715

816
A sync client can be used to read news and synchronize via the API.
917

18+
Last reviewed: May 2026
19+
1020
| Name | OS/Platform | License | Source |
1121
|------------------------------------------------------------------------------------------------------------------|------------------------------|----------------------|--------------------------------------------------------------------|
1222
| [RSS Guard](https://github.com/martinrotter/rssguard) | Windows, Linux, OS/2, macOS | GPL-3.0 License | [GitHub](https://github.com/martinrotter/rssguard) |
1323
| [Fluent Reader](https://hyliu.me/fluent-reader/) | Windows, Linux, macOS | BSD-3-Clause License | [GitHub](https://github.com/yang991178/fluent-reader) |
1424
| [Communique](https://flathub.org/apps/details/com.github.suzie97.communique) | Linux | LGPL-2.1 License | [GitHub](https://github.com/Suzie97/Communique) |
1525
| [NewsFlash](https://flathub.org/apps/details/com.gitlab.newsflash) | Linux | GPL-3.0 License | [GitLab](https://gitlab.com/news-flash/news_flash_gtk) |
1626
| [Nextcloud News Reader](https://play.google.com/store/apps/details?id=de.luhmer.owncloudnewsreader) | Android | GPL-3.0 License | [GitHub](https://github.com/nextcloud/news-android-app) |
17-
| [OCReader](https://f-droid.org/repository/browse/?fdid=email.schaal.ocreader) | Android | GPL-3.0 License | [GitHub](https://github.com/schaal/ocreader) |
18-
| [Newsout](https://play.google.com/store/apps/details?id=com.inspiredandroid.newsout) | Android | Apache-2.0 License | [GitHub](https://github.com/SimonSchubert/NewsOut) |
1927
| [Readrops](https://f-droid.org/en/packages/com.readrops.app/) | Android | GPL-3.0 License | [GitHub](https://github.com/readrops/Readrops) |
20-
| [CloudNews](https://apps.apple.com/app/cloudnews-owncloud-news-reader/id683859706) | iOS | BSD-2-Clause License | [GitHub](https://github.com/owncloud/news-ios-app) |
2128
| [Fiery Feeds](http://cocoacake.net/) | iOS, macOS | - | - |
22-
| [Nextnews](https://apps.apple.com/us/app/nextnews/id1573041539) | iOS | - | - |
23-
| [News Checker](https://chrome.google.com/webstore/detail/owncloud-news-checker/hnmagnmdnfdhabdlicankfbfhcdgbfhe) | Google Chrome | - | [GitHub](https://github.com/owncloud-archive/news-chrome-notifier) |
24-
| [own News](https://appworld.blackberry.com/webstore/content/32767887/) | Blackberry | - | - |
25-
| [FeedSpider](https://www.feedspider.net/) | Firefox OS, webOS, LuneOS | MIT License | [GitHub](https://github.com/OthelloVentures/feedspider) |
26-
| [fastReader](https://www.windowsphone.com/en-us/store/app/fastreader/e55e696d-aa45-4a49-bb1c-a1fc7fdabec1) | Windows Phone | - | - |
2729
| [py3status](https://github.com/ultrabug/py3status/) | i3wm | BSD-3-Clause License | [GitHub](https://github.com/ultrabug/py3status/) |
2830
| [newsboat](https://newsboat.org/) | Unix Terminal | MIT License | [GitHub](https://github.com/newsboat/newsboat) |
29-
| [Newsie](https://open-store.io/app/newsie.martinferretti) | Ubuntu Touch | GPL-3.0 License | [GitLab](https://gitlab.com/ferrettim/newsie) |
30-
| [Fuoten](https://github.com/Huessenbergnetz/Fuoten) | Sailfish OS | GPL-3.0 License | [GitHub](https://github.com/Huessenbergnetz/Fuoten) |
3131

3232
## Update Clients
3333

3434
An update client uses the News API or the OCC CLI to update the feeds in News.
3535

3636
* [Python multithread updater](https://github.com/nextcloud/news-updater)
37+

docs/user.md

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Provide a username and password if required for a feed. Please note that the pas
2222
### Auto discover Feed
2323
Check this option if you want the app to automatically detect the RSS feed from the entered URL. This is useful when you’re unsure of the exact feed URL, as the system will scan the provided website for RSS links.
2424

25-
## Feed options
25+
## Feed settings
2626

2727
### Mark Read
2828
Mark the feed as read.
@@ -53,6 +53,41 @@ Delete the feed.
5353
### Open Feed URL
5454
Open the feed in a new tab or window.
5555

56+
### Keyword Filters
57+
You can hide unwanted articles per feed by defining keyword filters.
58+
59+
How to open filters for a feed:
60+
- Open **Feed Settings**.
61+
- In the feed table, find your feed and click the **Keyword filters** icon in the options column.
62+
63+
How to add or change filters:
64+
- Enter comma-separated keywords in one or more fields:
65+
- **Title keywords**
66+
- **Body keywords**
67+
- **URL keywords**
68+
- Click **Save**.
69+
70+
How matching works:
71+
- Matching is **case-insensitive**.
72+
- **Title** and **Body** keywords match **whole words**.
73+
- **URL** keywords match **URL fragments**.
74+
- If an article matches any configured keyword, it is hidden for that feed.
75+
76+
How to see that items were filtered:
77+
- Filtered items are hidden from the article list.
78+
- If you expect an article but do not see it, open the feed's **Keyword filters** and review the configured keywords.
79+
- To verify quickly, temporarily remove a keyword (or click **Clear**) and check if the article appears.
80+
81+
How to remove filters:
82+
- Open the same dialog and click **Clear** to remove all keywords for that feed.
83+
84+
Simple example:
85+
- You want to hide promotional posts in one feed.
86+
- Set **Title keywords** to `sponsored, advertisement`.
87+
- Set **Body keywords** to `partner content`.
88+
- Click **Save**.
89+
- Articles from that feed that contain these keywords will no longer be shown as unread.
90+
5691
## Settings
5792

5893
### Keyboard Shortcuts
@@ -115,7 +150,15 @@ Feed lists in OPML format can be imported and exported here. Feeds that cannot b
115150

116151
# Using News with Clients
117152

118-
## TODO
119-
This documentation is work in progress.
120-
explain sync and link to clients page
153+
To use News with a mobile or desktop client:
154+
- Add your Nextcloud server URL and your account/app password in the client.
155+
- Follow the setup steps from the client itself (server address, credentials, and sync options).
156+
- After setup, the client syncs with your News server.
157+
158+
What gets synced:
159+
- Read/unread status
160+
- Starred items
161+
- Feed and folder structure
162+
163+
See the available clients and setup links on the [Clients](clients.md) page.
121164

0 commit comments

Comments
 (0)