Add CF-specific README

cloudflare · Apr 11, 2024 · 3beecfa · 3beecfa
1 parent 7aa5103
commit 3beecfa
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,9 @@
+# Cloudflare fork of Zlib
+
+This is a fork of zlib with performance improvements developed for use at Cloudflare.
+
+This implementation only supports x86-64 with SSE 4.2+ and aarch64 with NEON & CRC. 32-bit CPUs are not supported at all.
+
+The API and ABI are compatible with the original zlib.
+
+This library is also available as a [Rust crate](https://lib.rs/crates/cloudflare-zlib).