From 15b7e3deac67afc835c4805e5fb2c631e7ade2bf Mon Sep 17 00:00:00 2001 From: Carlo Alberto Ferraris Date: Mon, 24 Jan 2022 03:11:39 +0000 Subject: [PATCH] update readme --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 00b0b04..6942b86 100644 --- a/README.md +++ b/README.md @@ -91,18 +91,18 @@ http.Handle("/", compress(handler)) The `contrib/` directory contains a number of bundled implementations that are ready for use: -| `Content-Encoding` | Provider package | Implementation package | Notes | Dictionary | Go/cgo | Default | [IANA registry] | -| ------------------ | ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- | ----------------------------------------- | ---------- | ------ | ------- | --------------- | -| `deflate` | [contrib/compress/flate](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/compress/flate) | compress/flate | Slower than klauspost/flate | Yes | Go | Yes | Yes | -| `deflate` | [contrib/klauspost/flate](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/klauspost/flate) | [github.com/klauspost/compress/flate](https://github.com/klauspost/compress) | | Yes | Go | No | Yes | -| `gzip` | [contrib/compress/gzip](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/compress/gzip) | compress/gzip | Slower than klauspost/gzip | No | Go | Yes | Yes | -| `gzip` | [contrib/klauspost/gzip](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/klauspost/gzip) | [github.com/klauspost/compress/gzip](https://github.com/klauspost/compress) | | No | Go | No | Yes | -| `gzip` | [contrib/klauspost/pgzip](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/klauspost/pgzip) | [github.com/klauspost/pgzip](https://github.com/klauspost/pgzip) | Parallel compression | No | Go | No | Yes | -| `zstd` | [contrib/klauspost/zstd](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/klauspost/zstd) | [github.com/klauspost/compress/zstd](https://github.com/klauspost/compress) | | Yes | Go | Yes | Yes | -| `zstd` | [contrib/valyala/gozstd](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/valyala/gozstd) | [github.com/valyala/gozstd](https://github.com/valyala/gozstd) | Slower than klauspost/zstd | Yes | cgo | No | Yes | -| `brotli` | [contrib/andybalholm/brotli](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/andybalholm/brotli) | [github.com/andybalholm/brotli](https://github.com/andybalholm/brotli) | Slower than google/brotli | No | Go | Yes | Yes | -| `brotli` | [contrib/google/cbrotli](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/google/cbrotli) | [github.com/google/brotli](https://github.com/google/brotli) | Requires brotli libraries to be installed | No | cgo | No | Yes | -| `lz4` | [contrib/pierrec/lz4](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/pierrec/lz4) | [github.com/pierrec/lz4/v4](https://github.com/pierrec/lz4) | | No | Go | No | No | +| `Content-Encoding` | Provider package | Implementation package | Notes | Dictionary | Go/cgo | Default | [IANA registry] | +| ------------------ | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------- | ----------------------------------------- | ---------- | ------ | ------- | --------------- | +| `deflate` | [contrib/compress/zlib](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/compress/zlib) | compress/zlib | Slower than klauspost/zlib | Yes | Go | Yes | Yes | +| `deflate` | [contrib/klauspost/zlib](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/klauspost/zlib) | [github.com/klauspost/compress/zlib](https://github.com/klauspost/compress) | | Yes | Go | No | Yes | +| `gzip` | [contrib/compress/gzip](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/compress/gzip) | compress/gzip | Slower than klauspost/gzip | No | Go | Yes | Yes | +| `gzip` | [contrib/klauspost/gzip](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/klauspost/gzip) | [github.com/klauspost/compress/gzip](https://github.com/klauspost/compress) | | No | Go | No | Yes | +| `gzip` | [contrib/klauspost/pgzip](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/klauspost/pgzip) | [github.com/klauspost/pgzip](https://github.com/klauspost/pgzip) | Parallel compression | No | Go | No | Yes | +| `zstd` | [contrib/klauspost/zstd](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/klauspost/zstd) | [github.com/klauspost/compress/zstd](https://github.com/klauspost/compress) | | Yes | Go | Yes | Yes | +| `zstd` | [contrib/valyala/gozstd](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/valyala/gozstd) | [github.com/valyala/gozstd](https://github.com/valyala/gozstd) | Slower than klauspost/zstd | Yes | cgo | No | Yes | +| `brotli` | [contrib/andybalholm/brotli](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/andybalholm/brotli) | [github.com/andybalholm/brotli](https://github.com/andybalholm/brotli) | Slower than google/brotli | No | Go | Yes | Yes | +| `brotli` | [contrib/google/cbrotli](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/google/cbrotli) | [github.com/google/brotli](https://github.com/google/brotli) | Requires brotli libraries to be installed | No | cgo | No | Yes | +| `lz4` | [contrib/pierrec/lz4](https://pkg.go.dev/github.com/CAFxX/httpcompression/contrib/pierrec/lz4) | [github.com/pierrec/lz4/v4](https://github.com/pierrec/lz4) | | No | Go | No | No | ## Benchmark