From eef3b310e7081c4a636bb29739fb99cb917d4974 Mon Sep 17 00:00:00 2001
From: Joseph Hale <47901316+thehale@users.noreply.github.com>
Date: Tue, 23 May 2023 14:43:25 -0700
Subject: feat(tt-rss): Optionally limit notifications to a Category. (#370)

---
 recipes/tt-rss/README.md | 38 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

(limited to 'recipes/tt-rss/README.md')

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 @@
 # Tiny Tiny RSS for Ferdium
 
-Support for [Tiny Tiny RSS](https://tt-rss.org/)
+Interact with [Tiny Tiny RSS](https://tt-rss.org/) inside of Ferdium!
+
+## Usage
+
+1. Search for "RSS" in Ferdium's **Available Services**
+2. Enter the URL of your Tiny Tiny RSS server
+3. Save the service and log in!
+
+## Configuration
+
+### `ferdiumNotificationLabel`
+
+You can limit notifications from Tiny Tiny RSS to new articles in a specific
+Category using the custom `ferdiumNotificationLabel` query parameter as part of
+your server URL.
+
+```
+https://ttrss.example.com/tt-rss/?ferdiumNotificationLabel=CATEGORY_NAME
+```
+
+For example, if I wanted to only see notifications from a Category titled
+`Software - Updates`, I would use one of the following query parameters:
+
+```
+?ferdiumNotificationLabel=Software - Updates
+```
+**OR**
+```
+?ferdiumNotificationLabel=Software%20-%20Updates
+```
+
+The second option is the better/safer approach to take, but the first also works
+because Ferdium will escape the spaces for you (at least as of version 6.2.7).
+
+NOTE: When using the `ferdiumNotificationLabel` configuration, all other unread
+articles in other categories are reported as [**indirect**
+messages](https://github.com/ferdium/ferdium-recipes/blob/main/docs/frontend_api.md#setbadgedirectmessages-indirectmessages).
\ No newline at end of file
-- 
cgit v1.2.3-70-g09d2