Treebrary.org/rss-thread-watcher
1
0
Fork 0
Code Issues 19 Pull requests Projects 2 Releases 2 Packages Wiki Activity

Update README with more goals and better default values in URL parameters tavble

Browse source
This commit is contained in:
Felisp 2023-12-24 00:21:49 +01:00
parent f36f5be5d0
commit f392c8f897
1 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.org
View file

@ -20,13 +20,13 @@ Right now there is no automated way to generate your feed url but making one by
**** URL parameters
| Param name | Default value | Can have multiple? | Mandatory? | Short 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 |
| chod | 94 | No | No | CHanceOfDeath - will include thread in the feed if it's chance to death i > chod |
| repeat | ~false~ | No | No | 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) |
| Param name | Default value | 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 | 94 | No | No | CHanceOfDeath - will include thread in the feed if it's chance to death i > chod |
| repeat | ~false~ | No | No | 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) |
**** How to create URL
@ -42,8 +42,12 @@ This is an experimental project. There are several limitations:
** Feature set
- Planned/finnished features
- Planned/finnished features [7%]
- [X] Super basic features done (feed, query, repeat)
- [ ] No params request should redirect to url generator or (for now) documentation
- [ ] Have proper sorting - The most likely to die threads first (stačí dát reverse u posledního vstupu filtru?)
- [ ] 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)