diff options
Diffstat (limited to 'recipes/tt-rss/README.md')
-rw-r--r-- | recipes/tt-rss/README.md | 38 |
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 | ||
3 | Support for [Tiny Tiny RSS](https://tt-rss.org/) | 3 | Interact with [Tiny Tiny RSS](https://tt-rss.org/) inside of Ferdium! |
4 | |||
5 | ## Usage | ||
6 | |||
7 | 1. Search for "RSS" in Ferdium's **Available Services** | ||
8 | 2. Enter the URL of your Tiny Tiny RSS server | ||
9 | 3. Save the service and log in! | ||
10 | |||
11 | ## Configuration | ||
12 | |||
13 | ### `ferdiumNotificationLabel` | ||
14 | |||
15 | You can limit notifications from Tiny Tiny RSS to new articles in a specific | ||
16 | Category using the custom `ferdiumNotificationLabel` query parameter as part of | ||
17 | your server URL. | ||
18 | |||
19 | ``` | ||
20 | https://ttrss.example.com/tt-rss/?ferdiumNotificationLabel=CATEGORY_NAME | ||
21 | ``` | ||
22 | |||
23 | For 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 | |||
34 | The second option is the better/safer approach to take, but the first also works | ||
35 | because Ferdium will escape the spaces for you (at least as of version 6.2.7). | ||
36 | |||
37 | NOTE: When using the `ferdiumNotificationLabel` configuration, all other unread | ||
38 | articles in other categories are reported as [**indirect** | ||
39 | messages](https://github.com/ferdium/ferdium-recipes/blob/main/docs/frontend_api.md#setbadgedirectmessages-indirectmessages). \ No newline at end of file | ||