diff --git a/Cargo.lock b/Cargo.lock index b4d4bcb..6cee6fb 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -693,7 +693,7 @@ dependencies = [ [[package]] name = "rusty-downloader" -version = "0.1.0" +version = "0.2.0" dependencies = [ "clap", "colored", diff --git a/Cargo.toml b/Cargo.toml index 6076a65..a8803e6 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "rusty-downloader" -version = "0.1.0" +version = "0.2.0" edition = "2021" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/README.md b/README.md new file mode 100644 index 0000000..48fcdd5 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +
+ +
+ +## Rust-powered image downloader for 4chan + +Minimal concurrent image downloader for 4chan threads/boards. + +

+ + +

+ +### Installation and usage + +Build and run with + +```shell +cargo run -- +``` + +```shell +USAGE: + rusty-downloader --output <--thread |--board > + +OPTIONS: + -b, --board Set a board URL + -h, --help Print help information + -o, --output Set an output directory + -t, --thread Set a thread URL + -V, --version Print version information +``` diff --git a/src/main.rs b/src/main.rs index 6ccb68c..77a1184 100644 --- a/src/main.rs +++ b/src/main.rs @@ -17,10 +17,10 @@ enum Mode { } fn parse_cli_args() -> Result<(PathBuf, String, Mode)> { - let matches = Command::new("WGDL-imagescraper written in Rust") - .version("0.1.0") + let matches = Command::new("Rust-powered image downloader for 4chan") + .version("0.2.0") .author("Arttu Einistö ") - .about("Scrapes images efficiently from 4chan.org") + .about("Minimal asynchronous image downloader for 4chan threads/boards") .arg( Arg::new("output") .short('o')