Skip to content

Commit

Permalink
add usage info
Browse files Browse the repository at this point in the history
  • Loading branch information
pheyvaer committed Oct 31, 2018
1 parent 470d244 commit c5840f7
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit c5840f7

Please sign in to comment.