diff --git a/README.md b/README.md index 519428b..67bf4d9 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ +

+ GitHub Actions Build Status + Fuzzing Status +

Brotli

-# SECURITY NOTE - -Please consider updating brotli to version 1.0.9 (latest). - -Version 1.0.9 contains a fix to "integer overflow" problem. This happens when "one-shot" decoding API is used (or input chunk for streaming API is not limited), input size (chunk size) is larger than 2GiB, and input contains uncompressed blocks. After the overflow happens, `memcpy` is invoked with a gigantic `num` value, that will likely cause the crash. - ### Introduction Brotli is a generic-purpose lossless compression algorithm that compresses data @@ -23,12 +21,6 @@ Brotli is open-sourced under the MIT License, see the LICENSE file. > to modify "raw" ranges of the compressed stream and the decoder will not > notice that. -Brotli mailing list: -https://groups.google.com/forum/#!forum/brotli - -![GitHub Actions Build Status](https://github.com/google/brotli/actions/workflows/build_test.yml/badge.svg) -[![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/brotli.svg)](https://oss-fuzz-build-logs.storage.googleapis.com/index.html#brotli) - ### Build instructions #### Vcpkg @@ -70,6 +62,18 @@ To install the tip-of-the-tree version, run: See the [Python readme](python/README.md) for more details on installing from source, development, and testing. +### Contributing + +We glad to answer/library related questions in +[brotli mailing list](https://groups.google.com/forum/#!forum/brotli). + +Regular issues / feature requests should be reported in +[issue tracker](https://github.com/google/brotli/issues). + +For reporting vulnerability please read [SECURITY](SECURITY.md). + +For contributing changes please read [CONTRIBUTING](CONTRIBUTING.md). + ### Benchmarks * [Squash Compression Benchmark](https://quixdb.github.io/squash-benchmark/) / [Unstable Squash Compression Benchmark](https://quixdb.github.io/squash-benchmark/unstable/) * [Large Text Compression Benchmark](http://mattmahoney.net/dc/text.html)