Rename to shared-brotli-patch-decoder and add a basic README.

Cargo.toml

@@ -12,7 +12,7 @@ members = [
     "fauntlet",
     "klippa",
     "fuzz",
-    "shared-brotli",
+    "shared-brotli-patch-decoder",
 ]
 
 [workspace.package]
@@ -45,7 +45,7 @@ read-fonts = { version = "0.22.2", path = "read-fonts", default-features = false
 # shaping support
 skrifa = { version = "0.22.2", path = "skrifa", default-features = false, features = ["std"] }
 write-fonts = { version = "0.29.0", path = "write-fonts" }
-shared-brotli = { version = "0.1.0", path = "shared-brotli" }
+shared-brotli-patch-decoder = { version = "0.1.0", path = "shared-brotli-patch-decoder" }
 
 [workspace.metadata.release]
 allow-branch = ["main"]

shared-brotli/Cargo.toml → shared-brotli-patch-decoder/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
-name = "shared-brotli"
+name = "shared-brotli-patch-decoder"
 version = "0.1.0"
-description = "Wrapper around brotli-sys which allows for decoding shared brotli (https://datatracker.ietf.org/doc/draft-vandevenne-shared-brotli-format/) encoded data."
+description = "Wrapper around brotli-sys which allows for decoding shared brotli (https://datatracker.ietf.org/doc/draft-vandevenne-shared-brotli-format/) encoded patch data."
 edition.workspace = true
 license.workspace = true
 repository.workspace = true

shared-brotli-patch-decoder/README.md

@@ -0,0 +1,6 @@
+# Shared Brotli Patch Decoder
+
+This crate provides a wrapper around brotlic-sys to provide a method for decoding brotli encoded data which utilizes a shared raw
+LZ77 dictionary. This is an extension to standard brotli decoding, which is specified here: https://datatracker.ietf.org/doc/html/draft-vandevenne-shared-brotli-format-11#section-3.2
+
+This is meant to primarily be used in the context of decoding incremental font transfer patches (see: https://w3c.github.io/IFT/Overview.html#table-keyed).