Add README.md & bump version

Cargo.lock

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

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

README.md

@@ -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
+```

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ö <einisto@proton.me>")
-        .about("Scrapes images efficiently from 4chan.org")
+        .about("Minimal asynchronous image downloader for 4chan threads/boards")
         .arg(
             Arg::new("output")
                 .short('o')