Skip to content

Commit

Permalink
adding in readme for @keyv/compress-brotli (#453)
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredwray authored Aug 29, 2022
1 parent b14b372 commit a3e353b
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions packages/compress-brotli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# @keyv/tiered [<img width="100" align="right" src="https://rawgit.com/lukechilds/keyv/master/media/logo.svg" alt="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

0 comments on commit a3e353b

Please sign in to comment.