creating README.md for each crate separately, for crates.io

4 files changed, 318 insertions, 259 deletions

diff --git a/Cargo.lock b/Cargo.lock
index fcccb58..e319f60 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -1,258 +1,258 @@
-# This file is automatically @generated by Cargo.

-# It is not intended for manual editing.

-version = 4

-

-[[package]]

-name = "anstream"

-version = "0.6.18"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "8acc5369981196006228e28809f761875c0327210a891e941f4c683b3a99529b"

-dependencies = [

- "anstyle",

- "anstyle-parse",

- "anstyle-query",

- "anstyle-wincon",

- "colorchoice",

- "is_terminal_polyfill",

- "utf8parse",

-]

-

-[[package]]

-name = "anstyle"

-version = "1.0.10"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "55cc3b69f167a1ef2e161439aa98aed94e6028e5f9a59be9a6ffb47aef1651f9"

-

-[[package]]

-name = "anstyle-parse"

-version = "0.2.6"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "3b2d16507662817a6a20a9ea92df6652ee4f94f914589377d69f3b21bc5798a9"

-dependencies = [

- "utf8parse",

-]

-

-[[package]]

-name = "anstyle-query"

-version = "1.1.2"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "79947af37f4177cfead1110013d678905c37501914fba0efea834c3fe9a8d60c"

-dependencies = [

- "windows-sys",

-]

-

-[[package]]

-name = "anstyle-wincon"

-version = "3.0.7"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "ca3534e77181a9cc07539ad51f2141fe32f6c3ffd4df76db8ad92346b003ae4e"

-dependencies = [

- "anstyle",

- "once_cell",

- "windows-sys",

-]

-

-[[package]]

-name = "clap"

-version = "4.5.31"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "027bb0d98429ae334a8698531da7077bdf906419543a35a55c2cb1b66437d767"

-dependencies = [

- "clap_builder",

- "clap_derive",

-]

-

-[[package]]

-name = "clap_builder"

-version = "4.5.31"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "5589e0cba072e0f3d23791efac0fd8627b49c829c196a492e88168e6a669d863"

-dependencies = [

- "anstream",

- "anstyle",

- "clap_lex",

- "strsim",

-]

-

-[[package]]

-name = "clap_derive"

-version = "4.5.28"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "bf4ced95c6f4a675af3da73304b9ac4ed991640c36374e4b46795c49e17cf1ed"

-dependencies = [

- "heck",

- "proc-macro2",

- "quote",

- "syn",

-]

-

-[[package]]

-name = "clap_lex"

-version = "0.7.4"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "f46ad14479a25103f283c0f10005961cf086d8dc42205bb44c46ac563475dca6"

-

-[[package]]

-name = "colorchoice"

-version = "1.0.3"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "5b63caa9aa9397e2d9480a9b13673856c78d8ac123288526c37d7839f2a86990"

-

-[[package]]

-name = "heck"

-version = "0.5.0"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"

-

-[[package]]

-name = "hex"

-version = "0.4.3"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "7f24254aa9a54b5c858eaee2f5bccdb46aaf0e486a595ed5fd8f86ba55232a70"

-

-[[package]]

-name = "is_terminal_polyfill"

-version = "1.70.1"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "7943c866cc5cd64cbc25b2e01621d07fa8eb2a1a23160ee81ce38704e97b8ecf"

-

-[[package]]

-name = "once_cell"

-version = "1.20.3"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "945462a4b81e43c4e3ba96bd7b49d834c6f61198356aa858733bc4acf3cbe62e"

-

-[[package]]

-name = "proc-macro2"

-version = "1.0.94"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "a31971752e70b8b2686d7e46ec17fb38dad4051d94024c88df49b667caea9c84"

-dependencies = [

- "unicode-ident",

-]

-

-[[package]]

-name = "quote"

-version = "1.0.39"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "c1f1914ce909e1658d9907913b4b91947430c7d9be598b15a1912935b8c04801"

-dependencies = [

- "proc-macro2",

-]

-

-[[package]]

-name = "strsim"

-version = "0.11.1"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f"

-

-[[package]]

-name = "syn"

-version = "2.0.99"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "e02e925281e18ffd9d640e234264753c43edc62d64b2d4cf898f1bc5e75f3fc2"

-dependencies = [

- "proc-macro2",

- "quote",

- "unicode-ident",

-]

-

-[[package]]

-name = "unicode-ident"

-version = "1.0.18"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "5a5f39404a5da50712a4c1eecf25e90dd62b613502b7e925fd4e4d19b5c96512"

-

-[[package]]

-name = "utf8parse"

-version = "0.2.2"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"

-

-[[package]]

-name = "windows-sys"

-version = "0.59.0"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b"

-dependencies = [

- "windows-targets",

-]

-

-[[package]]

-name = "windows-targets"

-version = "0.52.6"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973"

-dependencies = [

- "windows_aarch64_gnullvm",

- "windows_aarch64_msvc",

- "windows_i686_gnu",

- "windows_i686_gnullvm",

- "windows_i686_msvc",

- "windows_x86_64_gnu",

- "windows_x86_64_gnullvm",

- "windows_x86_64_msvc",

-]

-

-[[package]]

-name = "windows_aarch64_gnullvm"

-version = "0.52.6"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3"

-

-[[package]]

-name = "windows_aarch64_msvc"

-version = "0.52.6"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469"

-

-[[package]]

-name = "windows_i686_gnu"

-version = "0.52.6"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b"

-

-[[package]]

-name = "windows_i686_gnullvm"

-version = "0.52.6"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66"

-

-[[package]]

-name = "windows_i686_msvc"

-version = "0.52.6"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66"

-

-[[package]]

-name = "windows_x86_64_gnu"

-version = "0.52.6"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78"

-

-[[package]]

-name = "windows_x86_64_gnullvm"

-version = "0.52.6"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d"

-

-[[package]]

-name = "windows_x86_64_msvc"

-version = "0.52.6"

-source = "registry+https://github.com/rust-lang/crates.io-index"

-checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"

-

-[[package]]

-name = "zlib-header"

-version = "0.1.0"

-dependencies = [

- "hex",

-]

-

-[[package]]

-name = "zlib-header-cli"

-version = "0.1.0"

-dependencies = [

- "clap",

- "zlib-header",

-]

+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "anstream"
+version = "0.6.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8acc5369981196006228e28809f761875c0327210a891e941f4c683b3a99529b"
+dependencies = [
+ "anstyle",
+ "anstyle-parse",
+ "anstyle-query",
+ "anstyle-wincon",
+ "colorchoice",
+ "is_terminal_polyfill",
+ "utf8parse",
+]
+
+[[package]]
+name = "anstyle"
+version = "1.0.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "55cc3b69f167a1ef2e161439aa98aed94e6028e5f9a59be9a6ffb47aef1651f9"
+
+[[package]]
+name = "anstyle-parse"
+version = "0.2.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3b2d16507662817a6a20a9ea92df6652ee4f94f914589377d69f3b21bc5798a9"
+dependencies = [
+ "utf8parse",
+]
+
+[[package]]
+name = "anstyle-query"
+version = "1.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "79947af37f4177cfead1110013d678905c37501914fba0efea834c3fe9a8d60c"
+dependencies = [
+ "windows-sys",
+]
+
+[[package]]
+name = "anstyle-wincon"
+version = "3.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ca3534e77181a9cc07539ad51f2141fe32f6c3ffd4df76db8ad92346b003ae4e"
+dependencies = [
+ "anstyle",
+ "once_cell",
+ "windows-sys",
+]
+
+[[package]]
+name = "clap"
+version = "4.5.31"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "027bb0d98429ae334a8698531da7077bdf906419543a35a55c2cb1b66437d767"
+dependencies = [
+ "clap_builder",
+ "clap_derive",
+]
+
+[[package]]
+name = "clap_builder"
+version = "4.5.31"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5589e0cba072e0f3d23791efac0fd8627b49c829c196a492e88168e6a669d863"
+dependencies = [
+ "anstream",
+ "anstyle",
+ "clap_lex",
+ "strsim",
+]
+
+[[package]]
+name = "clap_derive"
+version = "4.5.28"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bf4ced95c6f4a675af3da73304b9ac4ed991640c36374e4b46795c49e17cf1ed"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "clap_lex"
+version = "0.7.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f46ad14479a25103f283c0f10005961cf086d8dc42205bb44c46ac563475dca6"
+
+[[package]]
+name = "colorchoice"
+version = "1.0.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5b63caa9aa9397e2d9480a9b13673856c78d8ac123288526c37d7839f2a86990"
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "hex"
+version = "0.4.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7f24254aa9a54b5c858eaee2f5bccdb46aaf0e486a595ed5fd8f86ba55232a70"
+
+[[package]]
+name = "is_terminal_polyfill"
+version = "1.70.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7943c866cc5cd64cbc25b2e01621d07fa8eb2a1a23160ee81ce38704e97b8ecf"
+
+[[package]]
+name = "once_cell"
+version = "1.20.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "945462a4b81e43c4e3ba96bd7b49d834c6f61198356aa858733bc4acf3cbe62e"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.94"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a31971752e70b8b2686d7e46ec17fb38dad4051d94024c88df49b667caea9c84"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.39"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c1f1914ce909e1658d9907913b4b91947430c7d9be598b15a1912935b8c04801"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "strsim"
+version = "0.11.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f"
+
+[[package]]
+name = "syn"
+version = "2.0.99"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e02e925281e18ffd9d640e234264753c43edc62d64b2d4cf898f1bc5e75f3fc2"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5a5f39404a5da50712a4c1eecf25e90dd62b613502b7e925fd4e4d19b5c96512"
+
+[[package]]
+name = "utf8parse"
+version = "0.2.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
+
+[[package]]
+name = "windows-sys"
+version = "0.59.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b"
+dependencies = [
+ "windows-targets",
+]
+
+[[package]]
+name = "windows-targets"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973"
+dependencies = [
+ "windows_aarch64_gnullvm",
+ "windows_aarch64_msvc",
+ "windows_i686_gnu",
+ "windows_i686_gnullvm",
+ "windows_i686_msvc",
+ "windows_x86_64_gnu",
+ "windows_x86_64_gnullvm",
+ "windows_x86_64_msvc",
+]
+
+[[package]]
+name = "windows_aarch64_gnullvm"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3"
+
+[[package]]
+name = "windows_aarch64_msvc"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469"
+
+[[package]]
+name = "windows_i686_gnu"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b"
+
+[[package]]
+name = "windows_i686_gnullvm"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66"
+
+[[package]]
+name = "windows_i686_msvc"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66"
+
+[[package]]
+name = "windows_x86_64_gnu"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78"
+
+[[package]]
+name = "windows_x86_64_gnullvm"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d"
+
+[[package]]
+name = "windows_x86_64_msvc"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
+
+[[package]]
+name = "zlib-header"
+version = "0.1.1"
+dependencies = [
+ "hex",
+]
+
+[[package]]
+name = "zlib-header-cli"
+version = "0.1.0"
+dependencies = [
+ "clap",
+ "zlib-header",
+]
diff --git a/cli/README.md b/cli/README.md
new file mode 100644
index 0000000..046e697
--- /dev/null
+++ b/cli/README.md
@@ -0,0 +1,34 @@
+# zlib-header-cli

+CLI to print details about the 2 Byte zlib header, as defined in

+[RFC 1950](https://datatracker.ietf.org/doc/html/rfc1950).  

+This was initially written to reverse-engineer more details about Blizzard's proprietary MPQ archive format, which uses

+zlib streams to store data.  

+```

+Usage: zlib-header-cli [OPTIONS] [HEX4CHAR]

+

+Arguments:

+[HEX4CHAR]  A four-character hex string representing the ZlibHeader (Big Endian)

+

+Options:

+  -e, --explain  Explain the ZlibHeader struct and abbreviations

+  -h, --help     Print help

+```

+```

+drfrugal@karazhan:~$ zlib-header-cli 789C

+CM      8 (DEFLATE)

+CINFO   7 (Window: 32768 Bytes)

+FCHECK  28 (valid)

+FDICT   false (Preset Dictionary not used)

+FLEVEL  2 (default)

+```

+```

+drfrugal@karazhan:~$ zlib-header-cli --explain

+2 Byte zlib header according to https://datatracker.ietf.org/doc/html/rfc1950

+1st Byte - CMF (Compression Method and Flags)

+  0000_1111  CM      Compression Method   8, _ (DEFLATE, UNDEFINED)

+  1111_0000  CINFO   Compression Info     window size is 2.pow(CINFO + 8)

+2nd Byte - FLG (Flags)

+  0001_1111  FCHECK  Checksum Adjustment  valid if (CMF * 256 + FLG) % 31 == 0

+  0010_0000  FDICT   Preset Dictionary    a preset dictionary was used

+  1100_0000  FLEVEL  Compression Level    0, 1, 2, 3 (fastest, fast, default, best)

+```

diff --git a/lib/Cargo.toml b/lib/Cargo.toml
index a5e8c54..e364f9b 100644
--- a/lib/Cargo.toml
+++ b/lib/Cargo.toml
@@ -1,6 +1,6 @@
 [package]

 name = "zlib-header"

-version = "0.1.0"

+version = "0.1.1"

 edition = "2024"

 description = "Library to work with the 2 Byte zlib header, as defined in RFC 1950."

 license = "MIT"

diff --git a/lib/README.md b/lib/README.md
new file mode 100644
index 0000000..cbd6355
--- /dev/null
+++ b/lib/README.md
@@ -0,0 +1,25 @@
+# zlib-header

+Library to work with the 2 Byte zlib header, as defined in [RFC 1950](https://datatracker.ietf.org/doc/html/rfc1950).

+## Examples

+```

+use zlib_header::ZlibHeader;

+let cm = 8;

+let cinfo = 7;

+let fdict = false;

+let flevel = 2;

+let header = ZlibHeader::new(cm, cinfo, fdict, flevel);

+match header {

+  Ok(header) => {

+    println!("header is valid (strict): {}", header.is_valid_strict()); // header is valid (strict): true 

+  },

+  Err(err) => eprintln!("Unable to initialize zlib header: {:?}", err)

+}

+```

+```

+use zlib_header::ZlibHeader;

+let header = ZlibHeader::default();

+println!("Display: {}", header); // Display: 789C

+println!("Debug: {:?}", header); // Debug: ZlibHeader { DEFLATE | 32768 Bytes | default | Dictionary: false | valid }

+let bytes = [0x78, 0x9C];

+println!("header matches expected bytes: {}", header == bytes); // header matches expected bytes: true

+```