Update readme
This commit is contained in:
40
README.md
40
README.md
@@ -1,2 +1,40 @@
|
||||
# kotatsu-dl
|
||||
Easy-to-use cli manga downloader with a 1k+ sources supported
|
||||
Easy-to-use cross-platform manga downloader with a lot of manga sources supported
|
||||
|
||||
[](https://github.com/KotatsuApp/kotatsu-parsers) [](https://aur.archlinux.org/packages/kotatsu-dl-git)
|
||||
|
||||

|
||||
|
||||
# Installation
|
||||
|
||||
### For Windows/Linux/Mac users
|
||||
Just download the latest release and use it
|
||||
|
||||
```shell
|
||||
java -jar ./kotatsu-dl.jar
|
||||
```
|
||||
Java 17 or later is required
|
||||
|
||||
### For ArchLinux users
|
||||
The package is available in AUR
|
||||
|
||||
```shell
|
||||
yay -S kotatsu-dl-git
|
||||
```
|
||||
When installed from AUR the `kotatsu-dl` command will be available system-wide.
|
||||
|
||||
# Usage
|
||||
|
||||
```shell
|
||||
Usage: kotatsu-dl [<options>] <link>
|
||||
|
||||
Options:
|
||||
--dest, --destination=<value> Output file or directory path. Default is current directory
|
||||
--format=(cbz|zip|dir) Output format
|
||||
--throttle Slow down downloading to avoid blocking your IP address by server
|
||||
--chapters=<numbers or range> Numbers of chapters to download. Can be a single numbers or range, e.g. "1-4,8,11" or "all"
|
||||
-h, --help Show this message and exit
|
||||
|
||||
Arguments:
|
||||
<link> Direct link to the manga copied from browser as is
|
||||
```
|
||||
|
||||
@@ -20,10 +20,13 @@ import java.io.File
|
||||
|
||||
class Main : AppCommand(name = "kotatsu-dl") {
|
||||
|
||||
private val link: String by argument()
|
||||
private val link: String by argument(
|
||||
name = "link",
|
||||
help = "Direct link to the manga copied from browser as is",
|
||||
)
|
||||
private val destination: File? by option(
|
||||
names = arrayOf("--dest", "--destination"),
|
||||
help = "Output file or directory path",
|
||||
help = "Output file or directory path. Default is current directory",
|
||||
).convert {
|
||||
it.replaceFirst(Regex("^~"), System.getProperty("user.home"))
|
||||
}.file(
|
||||
|
||||
Reference in New Issue
Block a user