From 0b561e710b722e675e51e3bcf0a0ccbcadeea635 Mon Sep 17 00:00:00 2001
From: Andrew Welch <andrew@nystudio107.com>
Date: Tue, 12 Mar 2019 10:25:11 -0400
Subject: [PATCH] =?UTF-8?q?Add=20=E2=80=9CUsing=20Brotli=E2=80=9D?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Andrew Welch <andrew@nystudio107.com>
---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.md b/README.md
index ac1f06f..6ef103b 100644
--- a/README.md
+++ b/README.md
@@ -278,6 +278,33 @@ module.exports = {
 }
 ```
 
+### Using Brotli
+
+[Brotli](https://en.wikipedia.org/wiki/Brotli) is a compression algorithm originally developed by Google, and offers compression superior to gzip.
+
+Node 11.7.0 and later has [native support](https://nodejs.org/api/zlib.html#zlib_zlib_createbrotlicompress_options) for Brotli compression in its zlib module.
+
+We can take advantage of this built-in support for Brotli in Node 11.7.0 and later by just passing in the appropriate `algorithm` to the CompressionPlugin:
+
+```js
+// in your webpack.config.js
+module.exports = {
+  plugins: [
+    new CompressionPlugin({
+      filename: '[path].br[query]',
+      algorithm: 'brotliCompress',
+      test: /\.(js|css|html|svg)$/,
+      compressionOptions: { level: 11 },
+      threshold: 10240,
+      minRatio: 0.8,
+      deleteOriginalAssets: false
+    })
+  ]
+}
+```
+
+**N.B.:** The `level` option matches `BROTLI_PARAM_QUALITY` [for Brotli-based streams](https://nodejs.org/api/zlib.html#zlib_for_brotli_based_streams)
+
 ## Contributing
 
 Please take a moment to read our contributing guidelines if you haven't yet done so.