diff --git a/packages/compress-brotli/README.md b/packages/compress-brotli/README.md new file mode 100644 index 000000000..ba823bead --- /dev/null +++ b/packages/compress-brotli/README.md @@ -0,0 +1,40 @@ +# @keyv/tiered [keyv](https://github.com/lukechilds/keyv) + +> Brotli compression for Keyv + +[![build](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml/badge.svg)](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml) +[![codecov](https://codecov.io/gh/jaredwray/keyv/branch/main/graph/badge.svg?token=bRzR3RyOXZ)](https://codecov.io/gh/jaredwray/keyv) +[![npm](https://img.shields.io/npm/v/@keyv/compress-brotli.svg)](https://www.npmjs.com/package/@keyv/compress-brotli) +[![npm](https://img.shields.io/npm/dm/@keyv/compress-brotli)](https://npmjs.com/package/@keyv/compress-brotli) + +Brotli compression for [Keyv](https://github.com/jaredwray/keyv). + +Brotli is a data compression algorithm that is designed to be fast and efficient. + +## Install + +```shell +npm install --save keyv @keyv/compress-brotli +``` + +## Usage + +```javascript +const KeyvBrotli = require('@keyv/compress-brotli'); +const Keyv = require('keyv'); + +const keyv = new Keyv({store: new Map(), compression: new KeyvBrotli()}); + +``` + +## API + +### @keyv/compress-brotli(\[options]) + +#### options + +All options for @keyv/compress-brotli are based on the package [compress-brotli](https://github.com/Kikobeats/compress-brotli) + +## License + +MIT © Jared Wray \ No newline at end of file