diff --git a/README.org b/README.org index c3d8465..b362044 100644 --- a/README.org +++ b/README.org @@ -12,11 +12,11 @@ Get notifications from your feed reader when your favourite thread is about to d 4) Profit! RSS feed will include only the threads matching your querry so every notification your feed reader will send means your watched thread is about to die -*NOTE THAT THIS IS AN ALPHA RELEASE, IF YOUR THREAD DIES BECAUSE OF RSS-WATCHER MALLFUNCTION DO NOT BLAME ME* pls +*NOTE THAT THIS IS AN BETA RELEASE, IF YOUR THREAD DIES BECAUSE OF RSS-WATCHER MALLFUNCTION DO NOT BLAME ME* pls ** Getting custom URL -URL without any params (just ~/feed.xml~) won't work. You must specify at least one ~q~. See bellow. +URL without any params (just ~/feed~) won't work. You must specify at least one ~q~ or ~Q~. See bellow. *** Crafting URL by hand @@ -24,13 +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 +Please note that default values may vary depending on which instance/host/board 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 | 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 | +| Q | nil | Yes | No if ~q~ is present | This string is used to filter threads according to their titles, but is CaseSensitive | | 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) |