nuxt-compress/README.md

Runs gzip and brotli compression on static assets during Nuxt build

# nuxt-compress

A simple static asset compression module for Nuxt that runs Gzip and Brotli
compression during the build process.

This is significantly more efficient than compressing files on the fly,
especially for Brotli compression, which sacrifices CPU time for greater
compression.

For compression during runtime, see the `compressor` entry in the
[Nuxt configuration docs](https://nuxtjs.org/api/configuration-render/#compressor)

## Getting Started

1. Install the module

   ```console
   npm install -D nuxt-compress
   ```

   OR

   ```console
   yarn add -D nuxt-compress
   ```

2. Add `"nuxt-compress"` to your
   [`buildModules`](https://nuxtjs.org/docs/2.x/configuration-glossary/configuration-modules#buildmodules)

   ```js
   module.exports = {
     buildModules: ['nuxt-compress'],
   };
   ```

## Configuration

This module provides a simple interface to include
[compression-webpack-plugin](https://github.com/webpack-contrib/compression-webpack-plugin)
configured for both gzip and brotli compression.

It uses the same configuration options, which can be supplied as a second
argument to the entry in `"modules"` in your `nuxt.config.js`, or as a distinct
entry with the key `"nuxt-compress"`. See the
[Nuxt Modules guide](https://nuxtjs.org/guide/modules/) for more information.

For example:

```js
module.exports = {
  modules: [
    [
      'nuxt-compress',
      {
        gzip: {
          threshold: 8192,
        },
        brotli: {
          threshold: 8192,
        },
      },
    ],
  ],
};
```

OR

```js
module.exports = {
  modules: ['nuxt-compress'],
  'nuxt-compress': {
    gzip: {
      threshold: 8192,
    },
    brotli: {
      threshold: 8192,
    },
  },
};
```