From: Nathan Moinvaziri <nathan@nathanm.com>
Date: Tue, 19 May 2020 15:40:43 +0000 (-0700)
Subject: Added features list to README.md.
X-Git-Tag: 1.9.9-b1~287
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9dd427a1566a6273c4b409269a414459ccbdd2c6;p=thirdparty%2Fzlib-ng.git

Added features list to README.md.
---

diff --git a/README.md b/README.md
index e6c3a6be7..a1b68977e 100644
--- a/README.md
+++ b/README.md
@@ -51,6 +51,29 @@ or valuable testing.
 
 Please read LICENSE.md, it is very simple and very liberal.
 
+Features
+--------
+
+* Zlib compatible API with support for dual-linking
+* Modernized native API based on zlib API for ease of porting
+* Intel deflate medium and quick algorithms
+* Support for CPU intrinsics when available
+  * Adler32 implementation using ARM Neon
+  * Intel CRC32-B implementation using PCLMULQDQ
+  * Intel CRC32-C intrinics for hash tables
+  * ARM CRC32-B implementation using ACLE
+  * Slide hash implementations using AVX2, SSE2, & ARM Neon
+  * Inflate fast using SSE2, ARM Neon
+  * Deflate hooks for IBM Z DFLTCC
+* Code sanitizers, fuzzing, and coverage
+* GitHub Actions continuous integration on Windows, macOS, and Linux
+  * Emulated CI for ARM, AARCH64, PPC, PPC64, SPARC64, S390x using qemu
+* Unaligned memory read/writes and large bit buffer improvements
+* Includes improvements from Cloudflare and Intel forks
+* Configure, CMake, and NMake build system support
+* Modern C99 syntax and a clean code layout
+* Over 200 CMake unit tests
+
 Build
 -----