Add README.md & bump version

This commit is contained in:
einisto 2022-06-06 16:55:33 +03:00
parent 10dfd3a95a
commit 8917e1102b
4 changed files with 37 additions and 5 deletions

2
Cargo.lock generated
View File

@ -693,7 +693,7 @@ dependencies = [
[[package]] [[package]]
name = "rusty-downloader" name = "rusty-downloader"
version = "0.1.0" version = "0.2.0"
dependencies = [ dependencies = [
"clap", "clap",
"colored", "colored",

View File

@ -1,6 +1,6 @@
[package] [package]
name = "rusty-downloader" name = "rusty-downloader"
version = "0.1.0" version = "0.2.0"
edition = "2021" edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

32
README.md Normal file
View File

@ -0,0 +1,32 @@
<div align="center">
<span><img src="https://github.com/einisto/rusty-downloader/blob/main/ferris.png" width="400"></span>
</div>
## Rust-powered image downloader for 4chan
Minimal concurrent image downloader for 4chan threads/boards.
<p align="left">
<a href="https://www.gnu.org/licenses/gpl-3.0"><img src="https://img.shields.io/badge/License-GPLv3-blue.svg"></a>
<a href="https://github.com/einisto"><img src="https://img.shields.io/badge/GitHub-Follow%20on%20GitHub-inactive.svg?logo=github"></a>
</p>
### Installation and usage
Build and run with
```shell
cargo run -- <OPTIONS>
```
```shell
USAGE:
rusty-downloader --output <PATH> <--thread <URL>|--board <URL>>
OPTIONS:
-b, --board <URL> Set a board URL
-h, --help Print help information
-o, --output <PATH> Set an output directory
-t, --thread <URL> Set a thread URL
-V, --version Print version information
```

View File

@ -17,10 +17,10 @@ enum Mode {
} }
fn parse_cli_args() -> Result<(PathBuf, String, Mode)> { fn parse_cli_args() -> Result<(PathBuf, String, Mode)> {
let matches = Command::new("WGDL-imagescraper written in Rust") let matches = Command::new("Rust-powered image downloader for 4chan")
.version("0.1.0") .version("0.2.0")
.author("Arttu Einistö <einisto@proton.me>") .author("Arttu Einistö <einisto@proton.me>")
.about("Scrapes images efficiently from 4chan.org") .about("Minimal asynchronous image downloader for 4chan threads/boards")
.arg( .arg(
Arg::new("output") Arg::new("output")
.short('o') .short('o')