aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2023-09-30 22:01:50 -0700
committerGitHub <[email protected]>2023-09-30 22:01:50 -0700
commit7d718a3d4c63d06fdef80ca3843dce88cc5bf77d (patch)
tree2981f3755c0e968f957fc40517cfdd3cb70cf8da
parentfeat(suzuri): add folder if present to feed title (diff)
downloadsuzuri-7d718a3d4c63d06fdef80ca3843dce88cc5bf77d.tar.xz
suzuri-7d718a3d4c63d06fdef80ca3843dce88cc5bf77d.zip
docs(readme): add newsboat examples
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index adb5fab..6ade2e2 100644
--- a/README.md
+++ b/README.md
@@ -55,6 +55,15 @@ variables `SUZURI_TOKEN` and `SUZURI_FOLDER`.
- Generate an RSS feed of your feeds to read with local tooling; e.g.,
[newsboat](https://newsboat.org/).
+### [newsboat](https://newsboat.org/) Integration
+
+```
+# ~/.config/newsboat/urls
+
+"exec:SUZURI_RSS=1 SUZURI_MINIMAL=1 SUZURI_REVERSE=1 /path/to/suzuri <token>"
+"exec:SUZURI_RSS=1 SUZURI_MINIMAL=1 SUZURI_REVERSE=1 /path/to/suzuri <token> <folder>"
+```
+
## Licence
This project is licensed with the [GNU General Public License v3.0](LICENSE).