From 82d920cb3dbaa8b5886d598b369449ce26134812 Mon Sep 17 00:00:00 2001 From: Felisp Date: Sun, 8 Sep 2024 02:36:49 +0200 Subject: [PATCH] Update example config and improve documentation --- res/ExampleConfig-documented.edn | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/res/ExampleConfig-documented.edn b/res/ExampleConfig-documented.edn index 0d3c127..8c1111f 100644 --- a/res/ExampleConfig-documented.edn +++ b/res/ExampleConfig-documented.edn @@ -14,14 +14,12 @@ :starting-page 7 ;; Default ChOD to use if none is specified by the user :default-chod 94 - ;; If you want to do some preprocessing beforehand, you can override - ;; target URL for the board, but the response must be same the 4chan API would return - ;; /$board/catalog.json will be appended to this link - ;; This is target for API requests - :target "https://api.4chan.org" - ;; This host that has the actual threads, /board/thread-no will be appeneded - ;; to this - :host "https://boards.4chan.org" + ;; This is target for Catalog API requests + ;; {board} will be substitued for board + :target "https://api.4chan.org/{board}/catalog.json" + ;; This is where threads actually reside if different from :target + ;; you can use {board} and {threadnum} for substitutions + :host "https://boards.4chan.org/{board}/thread/{threadnum}" ;; Commented parts bellow are still unimplemented ;; ------ ;; Only download catalog when someone requests feed and cache is old