Update example config and improve documentation

This commit is contained in:
Felisp 2024-09-08 02:36:49 +02:00
parent 373f2f2996
commit 82d920cb3d

View file

@ -14,14 +14,12 @@
:starting-page 7 :starting-page 7
;; Default ChOD to use if none is specified by the user ;; Default ChOD to use if none is specified by the user
:default-chod 94 :default-chod 94
;; If you want to do some preprocessing beforehand, you can override ;; This is target for Catalog API requests
;; target URL for the board, but the response must be same the 4chan API would return ;; {board} will be substitued for board
;; /$board/catalog.json will be appended to this link :target "https://api.4chan.org/{board}/catalog.json"
;; This is target for API requests ;; This is where threads actually reside if different from :target
:target "https://api.4chan.org" ;; you can use {board} and {threadnum} for substitutions
;; This host that has the actual threads, /board/thread-no will be appeneded :host "https://boards.4chan.org/{board}/thread/{threadnum}"
;; to this
:host "https://boards.4chan.org"
;; Commented parts bellow are still unimplemented ;; Commented parts bellow are still unimplemented
;; ------ ;; ------
;; Only download catalog when someone requests feed and cache is old ;; Only download catalog when someone requests feed and cache is old