diff --git a/README.org b/README.org index 74c323d..c438af8 100644 --- a/README.org +++ b/README.org @@ -18,6 +18,15 @@ Get notifications from your feed reader when your favourite /mlp/ thread is abou Right now there is no automated way to generate your feed url but making one by hand is fairly simple. +**** URL parameters + +| Param name | Default value | Can have multiple? | Mandatory? | Description | +|------------+---------------+--------------------+-----------------+-----------------------------------------------------------------| +| board | "mlp" | No | No | Which board to generate feed for *ONLY* ​/mlp​/ is supported | +| q | "" | Yes | Yes (1 or more) | This string is used to filter threads according to their titles | +| recreate | ~bool~ | Not implemented | Not implemented | Whether to notify when thread is detected for the first time | + + *** Generating URL interactively Coming soon