From c5840f7a5e78aa7cb13c1fc40ba6d3bc5cb5c943 Mon Sep 17 00:00:00 2001 From: Pieter Heyvaert Date: Wed, 31 Oct 2018 11:47:01 +0100 Subject: [PATCH] add usage info --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 5baeab3..08920e3 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,19 @@ Linked Data can then be generated from this data via the corresponding [rules](h ## Usage +The tool takes the following arguments + +- `-V, --version`: output the version number +- `-e, --entity [entity]`: Choose between "anime" and "character" +- `-s, --start [start]`: Number of start page +- `-t, --stop [stop]`: Number of stop page +- `-o, --output [output]`: Path to output folder (default: "") +- `-v, --verbose`: Make the application more talkative +- `-h, --help`: output usage information + +When you execute `kitsu-downloader -e anime -s 0 -t 199 -o test`, +the first 200 pages of anime data will be downloaded and the 200 files will be put in the folder `test`. + ## License 2018 Between Our Worlds, [MIT License](https://github.com/betweenourworlds/kitsu-downloader/blob/master/LICENSE.md) \ No newline at end of file