From 4b7a6e66d817fec336ae5976f01eb021516aa009 Mon Sep 17 00:00:00 2001 From: Felisp Date: Tue, 24 Sep 2024 02:24:51 +0200 Subject: [PATCH] Make README tiny bit more usefull --- README.org | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.org b/README.org index b362044..648f447 100644 --- a/README.org +++ b/README.org @@ -41,14 +41,14 @@ this software but anyone running instance of RSS thread watcher can change them Standart rules of URLs apply, if you know how to pass params in URL to any website, you don't even have to read this - Open some text editor -- Paste in default URL: ~https://tools.treebrary.org/thread-watcher/feed.xml?~ (you can use plain HTTP if you want to) +- Paste in default URL: ~https://tools.treebrary.org/thread-watcher/feed?~ (you can use plain HTTP if you want to) - Now you can append any of the supported parameters (which you can find in the above table): - For example if we want to be informed about threads with "cute" in their title - - ~q=cute~ which would make ~https://tools.treebrary.org/thread-watcher/feed.xml?q=cute~ + - ~q=cute~ which would make ~https://tools.treebrary.org/thread-watcher/feed?q=cute~ - If you want more than one param, separate with ~&~, for example: - - ~q=cute~ and ~q=pretty~ would be ~https://tools.treebrary.org/thread-watcher/feed.xml?q=cute&q=pretty~ + - ~q=cute~ and ~q=pretty~ would be ~https://tools.treebrary.org/thread-watcher/feed?q=cute&q=pretty~ - Same is true for when you also want to specify ChoD - - ~https://tools.treebrary.org/thread-watcher/feed.xml?q=cute&q=pretty&chod=98~ + - ~https://tools.treebrary.org/thread-watcher/feed?q=cute&q=pretty&chod=98~ - This will only notify you about threads that: - Have ~cute~ or ~pretty~ in their title - Are in the lowest 98% part of catalog (it's on position ~147/150 e.g. 3 threads before being bumped off) @@ -81,6 +81,8 @@ See [[https://git.treebrary.org/Treebrary.org/rss-thread-watcher/issues?q=&type= - [ ] Support async responses - [ ] Graal VM support for native compilation +For more up to date and complete list of features, check [[https://git.treebrary.org/Treebrary.org/rss-thread-watcher/projects][open projects]]. + ** Self hosting As of first Beta release, self hosting is supported, please refer to [[file:res/ExampleConfig-documented.edn][documented example config]] for infomration on configuration