1<p align="center"> 2 <img src="https://github.com/google/brotli/actions/workflows/build_test.yml/badge.svg" alt="GitHub Actions Build Status" href="https://github.com/google/brotli/actions?query=branch%3Amaster"> 3 <img src="https://oss-fuzz-build-logs.storage.googleapis.com/badges/brotli.svg" alt="Fuzzing Status" href="https://oss-fuzz-build-logs.storage.googleapis.com/index.html#brotli"> 4</p> 5<p align="center"><img src="https://brotli.org/brotli.svg" alt="Brotli" width="64"></p> 6 7### Introduction 8 9Brotli is a generic-purpose lossless compression algorithm that compresses data 10using a combination of a modern variant of the LZ77 algorithm, Huffman coding 11and 2nd order context modeling, with a compression ratio comparable to the best 12currently available general-purpose compression methods. It is similar in speed 13with deflate but offers more dense compression. 14 15The specification of the Brotli Compressed Data Format is defined in [RFC 7932](https://tools.ietf.org/html/rfc7932). 16 17Brotli is open-sourced under the MIT License, see the LICENSE file. 18 19> **Please note:** brotli is a "stream" format; it does not contain 20> meta-information, like checksums or uncompresssed data length. It is possible 21> to modify "raw" ranges of the compressed stream and the decoder will not 22> notice that. 23 24### Build instructions 25 26#### Vcpkg 27 28You can download and install brotli using the [vcpkg](https://github.com/Microsoft/vcpkg/) dependency manager: 29 30 git clone https://github.com/Microsoft/vcpkg.git 31 cd vcpkg 32 ./bootstrap-vcpkg.sh 33 ./vcpkg integrate install 34 ./vcpkg install brotli 35 36The brotli port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository. 37 38#### Bazel 39 40See [Bazel](http://www.bazel.build/) 41 42#### CMake 43 44The basic commands to build and install brotli are: 45 46 $ mkdir out && cd out 47 $ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=./installed .. 48 $ cmake --build . --config Release --target install 49 50You can use other [CMake](https://cmake.org/) configuration. 51 52#### Python 53 54To install the latest release of the Python module, run the following: 55 56 $ pip install brotli 57 58To install the tip-of-the-tree version, run: 59 60 $ pip install --upgrade git+https://github.com/google/brotli 61 62See the [Python readme](python/README.md) for more details on installing 63from source, development, and testing. 64 65### Contributing 66 67We glad to answer/library related questions in 68[brotli mailing list](https://groups.google.com/forum/#!forum/brotli). 69 70Regular issues / feature requests should be reported in 71[issue tracker](https://github.com/google/brotli/issues). 72 73For reporting vulnerability please read [SECURITY](SECURITY.md). 74 75For contributing changes please read [CONTRIBUTING](CONTRIBUTING.md). 76 77### Benchmarks 78* [Squash Compression Benchmark](https://quixdb.github.io/squash-benchmark/) / [Unstable Squash Compression Benchmark](https://quixdb.github.io/squash-benchmark/unstable/) 79* [Large Text Compression Benchmark](http://mattmahoney.net/dc/text.html) 80* [Lzturbo Benchmark](https://sites.google.com/site/powturbo/home/benchmark) 81 82### Related projects 83> **Disclaimer:** Brotli authors take no responsibility for the third party projects mentioned in this section. 84 85Independent [decoder](https://github.com/madler/brotli) implementation by Mark Adler, based entirely on format specification. 86 87JavaScript port of brotli [decoder](https://github.com/devongovett/brotli.js). Could be used directly via `npm install brotli` 88 89Hand ported [decoder / encoder](https://github.com/dominikhlbg/BrotliHaxe) in haxe by Dominik Homberger. Output source code: JavaScript, PHP, Python, Java and C# 90 917Zip [plugin](https://github.com/mcmilk/7-Zip-Zstd) 92 93Dart [native bindings](https://github.com/thosakwe/brotli) 94 95Dart compression framework with [fast FFI-based Brotli implementation](https://pub.dev/documentation/es_compression/latest/brotli/brotli-library.html) with ready-to-use prebuilt binaries for Win/Linux/Mac 96
