Add package metadata

Author: caesay

Cargo.toml

@@ -1,3 +1,7 @@
 [workspace]
 members = ["ripzip", "ripzip-cli"]
 resolver = "2"
+
+[workspace.package]
+homepage = "https://github.com/velopack/ripzip-rs"
+repository = "https://github.com/velopack/ripzip-rs"

README.md

@@ -57,7 +57,7 @@ Archive sizes are identical between the two -- same DEFLATE algorithm, same comp
 
 ### Run benchmarks yourself
 
-```
+```sh
 cargo bench -p ripzip
 ```
 
@@ -70,7 +70,7 @@ Add to your `Cargo.toml`:
 ripzip = { path = "ripzip" }
 ```
 
-```rust
+```rust,no_run
 use std::path::Path;
 use ripzip::{NoProgress, compress_directory, extract_to_directory};
 
@@ -91,6 +91,7 @@ extract_to_directory(
     Path::new("output/"),
     &NoProgress,
 )?;
+# Ok::<(), ripzip::RipzipError>(())
 ```
 
 ### Progress Reporting
@@ -122,19 +123,19 @@ Progress callbacks fire at chunk granularity (256 KB), so even single large file
 
 ## CLI
 
-```
+```sh
 cargo install --path ripzip-cli
 ```
 
-```
+```text
 ripzip compress <DIR> -o <FILE> [--level 1-9] [--method deflate|zstd] [--quiet]
 ripzip extract <ARCHIVE> [-o <DIR>] [--quiet]
 ripzip list <ARCHIVE> [--verbose]
 ```
 
 Aliases: `c`, `x`, `l`.
 
-```
+```text
 $ ripzip compress my_project/ -o my_project.zip --method zstd
  [00:00:00] [####################################] 142.3MB/142.3MB (1.8GB/s)
 Created my_project.zip
@@ -163,7 +164,7 @@ Compressed   Original     Method   Name
 
 ## Architecture
 
-```
+```text
                      COMPRESSION PIPELINE
 
   walkdir ──> Vec<FileEntry> ──> rayon::par_iter ──> Vec<CompressedEntry>
@@ -192,7 +193,7 @@ Compressed   Original     Method   Name
 
 ## Project Structure
 
-```
+```text
 ripzip-rs/
   ripzip/           # Library crate
     src/
@@ -226,7 +227,7 @@ ripzip-rs/
 
 117 tests: 35 unit tests + 82 integration tests (3 ZIP64 stress tests are `#[ignore]`).
 
-```
+```sh
 cargo test
 ```
 

ripzip-cli/Cargo.toml

@@ -5,13 +5,16 @@ edition = "2021"
 rust-version = "1.75"
 description = "A multi-threaded zip/unzip CLI"
 license = "MIT"
+readme = "../README.md"
+homepage.workspace = true
+repository.workspace = true
 
 [[bin]]
 name = "ripzip"
 path = "src/main.rs"
 
 [dependencies]
-ripzip = { path = "../ripzip" }
+ripzip = { version = "0.1.0", path = "../ripzip" }
 clap = { version = "4", features = ["derive"] }
 indicatif = "0.18"
 anyhow = "1"

ripzip/Cargo.toml

@@ -5,6 +5,9 @@ edition = "2021"
 rust-version = "1.75"
 description = "A multi-threaded zip/unzip library"
 license = "MIT"
+readme = "../README.md"
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 flate2 = { version = "1", features = ["zlib-rs"] }

ripzip/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../../README.md")]
+
 pub mod compress;
 pub mod error;
 pub mod extract;