arhivach-downloader

commit 4cdace50f1ef418ab284d7d5f7a6bc6b7fbce712
parent 501041e1c0afd95c956a1467c870e8c5ac955894
Author: egor-achkasov <eaachkasov@gmail.com>
Date:   Mon,  9 Mar 2026 11:31:13 +0000

update readme

Diffstat:
M
README.md
 | 
28
+++++++++++++++++-----------

1 file changed, 17 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
@@ -4,32 +4,38 @@ Download threads from arhivach.vc and save them locally for offline access or pr
 
 # Usage
 
+## TUI
+
+Run arhivach-downloader-tui, paste the url in the first field, fill the arguments (see description the the CLI subsection) and press Enter.
+
 ## CLI
 
-`arhivach-downloader --help`:
+`arhivach-downloader-cli --help`:
 
 ```
-Usage: arhivarch-downloader-cli.exe [OPTIONS] <URL>
+Download threads from arhivach.
+
+Usage: arhivach-downloader-cli [OPTIONS] <URL>
 
 Arguments:
   <URL>  URL to download
 
 Options:
-  -d, --dir <DIR>            Path to download directory [default: .]
-  -e, --exporter <EXPORTER>  Exporter [default: html] [possible values: html]
-  -t, --thumb                Download thumbnail images, default: false
-  -f, --files                Download files (images, videos, gifs, etc), default: false
-  -r, --resume               Resume files and thumbnails downloading instead of overwriting. Useless if neither -t nor -f are set, default: false
-  -R, --retries <RETRIES>    Download retries in case of a error [default: 3]
-  -h, --help                 Print help
+  -d, --dir <DIR>                   Path to download directory [default: .]
+  -e, --exporter <EXPORTER>         Exporter [default: html] [possible values: html]
+  -t, --thumb                       Download thumbnail images, default: false
+  -f, --files                       Download files (images, videos, gifs, etc), default: false
+  -r, --resume                      Resume files and thumbnails downloading instead of overwriting. Useless if neither -t nor -f are set, default: false
+  -R, --retries <DOWNLOAD_RETRIES>  Download retries in case of a error [default: 3]
+  -h, --help                        Print help
 ```
 
-Creates a subdirectory named after the arhivach thread id (the number after `/thread/` in the URL) inside the download directory, and saves the thread there. Contents:
+Creates DIR and writes the following content:
 - `index.html` — the thread. Open it with your web browser.
 - `files/` (if `-f`/`--files` is given) — original files attached to posts. May be large if there are many videos.
 - `thumb/` (if `-t`/`--thumb` is given) — thumbnails needed to render file previews in the thread.
 
-Use `-r`/`--resume` to skip files and thumbnails that are already downloaded.
+Use `-r`/`--resume` to skip files and thumbnails that are already downloaded. Skips them even if they are partially downloaded or corrupted.
 
 Use `-d`/`--dir` to specify where to create the thread directory (defaults to the current directory).