From 533dcc992424f5226ccb171e9f6c33a8668899fb Mon Sep 17 00:00:00 2001 From: Felisp Date: Tue, 13 Aug 2024 03:43:25 +0200 Subject: [PATCH] Redon README a little bit beafore release But will need proof reading, it's almost 4 in the morning and thats not good for writing accuracy --- README.org | 49 ++++++++++++++++++++++--------------------------- 1 file changed, 22 insertions(+), 27 deletions(-) diff --git a/README.org b/README.org index df34812..e5537c4 100644 --- a/README.org +++ b/README.org @@ -1,7 +1,7 @@ #+OPTIONS: toc:nil * RSS based thread watcher -Get notifications from your feed reader when your favourite /mlp/ thread is about to die +Get notifications from your feed reader when your favourite thread is about to die ** Usage @@ -24,11 +24,14 @@ Right now there is no automated way to generate your feed url but making one by **** URL parameters +Please note that default values may vary depending on which host you use, these are the defaults that come with this software but +anyone running instance of RSS thread watcher can change them + | Param name | Values [default] | Can have multiple? | Mandatory? | Short description | |------------+-------------------------+--------------------+-------------------------+--------------------------------------------------------------------------------------------------| -| board | "mlp" | No | No (not implemented) | Which board to generate feed for, *ONLY* ​/mlp​/ is supported | -| q | nil | Yes | Yes (1 or more) | This string is used to filter threads according to their titles | -| chod | 60-99 [94] | No | No | CHanceOfDeath - will include thread in the feed if it's chance to death i > chod | +| board | "mlp" | No | No | Which board to generate feed for, only boards enabled by host will work | +| q | nil | Yes | Yes (1 or more) | This string is used to filter threads according to their titles, *REGEX NOT supported* yet | +| chod | 60-99 [94] | No | No | CHanceOfDeath - will include thread in the feed if it's chance to death is > chod | | repeat | true, paranoid, [false] | No | No (partly implemented) | Whether to make new notification on every server update even when thread doesnt have higher chod | | recreate | ~bool~ | Not implemented | Not implemented | Whether to notify when creation of new thread matching querry is detected (uses 4chans RSS) | @@ -50,62 +53,54 @@ Standart rules of URLs apply, if you know how to pass params in URL to any websi - Are in the lowest 98% part of catalog (it's on position ~147/150 e.g. 3 threads before being bumped off) - Note that ~//~ are not special characters ~q=/general/~ will work as expected and match thread with "​/general​/" in it's title - Also note that regex is *NOT* supported for now, so something like ~q=rainbow*~ will only match threads with "rainbow" followed - immedidatelly by ~*~ - in their title + immedidatelly by ~*~ in their title *** Generating URL interactively -Coming soon +Coming soon (not really) -** Limitations +** Bugs -This is an experimental project. There are several limitations: -- Only supported board is ​/mlp​/ (You can choose your own when self hosting) -- Only searched threads are those who are in the 50% closer to death part of the catalog - -*** Bugs - -See [[https://git.treebrary.org/Treebrary.org/rss-thread-watcher/issues][issues]] +See [[https://git.treebrary.org/Treebrary.org/rss-thread-watcher/issues?q=&type=all&state=open&labels=1&milestone=0&assignee=0&poster=0][issues]] ** Feature set -- Planned/finnished features [23%] +- Planned/finnished features [38%] - [X] [DONE] Super basic features done (feed, query, repeat) - [X] Have proper sorting - The most likely to die threads first - [X] No params request should redirect to url generator or (for now) documentation - - [ ] Config file instead of hardcoding config values + - [X] Config file instead of hardcoding config values - [ ] Include time of latest data fetch - [ ] Make threads have preview images taken from the actuall thread OP - [ ] Show which query matched the thread you were notified of - [ ] Option to include advanced HTML formating of text (different color text for ChoD etc) - [ ] Support notification on watched thread re-creation after it died - [ ] Support notification for thread death - - [ ] Support multiple boards at once + - [X] Support multiple boards at once - [ ] Support async responses - [ ] Graal VM support for native configuration ** Self hosting -This is not supported until release 1.0. You can do it if you figure it out (probably not that hard tbh) but there will be much -more detailed instructions in the future. +As of first Beta release, self hosting is supported, please refer to [[file:res/ExampleConfig-documented.edn][documented example config]] for infomration on configuration +options. *** Prebuilt -There will be instructions at some point I promise. Until then you can download binaries from the releases page and run them like -you would any other java executable, default port is ~6969~. - -And you need Java for now if that isn't clear. - +Download newest release from [[https://git.treebrary.org/Treebrary.org/rss-thread-watcher/releases][releases]] and run them like you would any other java executable, default port is ~6969~ ~$ java -jar whatEverNameTheReleaseHas.jar~~ *** From source +Not officially supported, if you'll attempt this, please, use source from release tarball or checkout ~release~ or ~stable~ +branch. ~dev~ branch is unstable and untested, may not even build. ~stable~ branch should always build, may contain newer version +than is released. -If you know Clojure, then just clone and build with lein. If you don't either RTFM to lein or wait before instructions will be +If you know Clojure, then just clone and build with lein. If you don't either RTFM for lein or wait before instructions will be avaiabile here. *** Configuring -Self hosting is not supported at the moment so no configuration for you. +All documentation is for now included in [[file:res/ExampleConfig-documented.edn][documented exmample config]]. *** Contributing