aboutsummaryrefslogtreecommitdiffstats
path: root/recipes/tt-rss/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'recipes/tt-rss/README.md')
-rw-r--r--recipes/tt-rss/README.md38
1 files changed, 37 insertions, 1 deletions
diff --git a/recipes/tt-rss/README.md b/recipes/tt-rss/README.md
index d0ef122..a4866d4 100644
--- a/recipes/tt-rss/README.md
+++ b/recipes/tt-rss/README.md
@@ -1,3 +1,39 @@
1# Tiny Tiny RSS for Ferdium 1# Tiny Tiny RSS for Ferdium
2 2
3Support for [Tiny Tiny RSS](https://tt-rss.org/) 3Interact with [Tiny Tiny RSS](https://tt-rss.org/) inside of Ferdium!
4
5## Usage
6
71. Search for "RSS" in Ferdium's **Available Services**
82. Enter the URL of your Tiny Tiny RSS server
93. Save the service and log in!
10
11## Configuration
12
13### `ferdiumNotificationLabel`
14
15You can limit notifications from Tiny Tiny RSS to new articles in a specific
16Category using the custom `ferdiumNotificationLabel` query parameter as part of
17your server URL.
18
19```
20https://ttrss.example.com/tt-rss/?ferdiumNotificationLabel=CATEGORY_NAME
21```
22
23For example, if I wanted to only see notifications from a Category titled
24`Software - Updates`, I would use one of the following query parameters:
25
26```
27?ferdiumNotificationLabel=Software - Updates
28```
29**OR**
30```
31?ferdiumNotificationLabel=Software%20-%20Updates
32```
33
34The second option is the better/safer approach to take, but the first also works
35because Ferdium will escape the spaces for you (at least as of version 6.2.7).
36
37NOTE: When using the `ferdiumNotificationLabel` configuration, all other unread
38articles in other categories are reported as [**indirect**
39messages](https://github.com/ferdium/ferdium-recipes/blob/main/docs/frontend_api.md#setbadgedirectmessages-indirectmessages). \ No newline at end of file