-
Notifications
You must be signed in to change notification settings - Fork 152
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adding in readme for @keyv/compress-brotli (#453)
- Loading branch information
Showing
1 changed file
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |