Skip to content

Commit 123db08

Browse files
committed
chore: update readme
1 parent 8f94d93 commit 123db08

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,20 @@ Drop-in replacement of the built-in [Compress Middleware](https://hono.dev/docs/
66

77
### Features
88

9-
- all compression formats: `zstd`, `br`, `gzip`, `deflate`
10-
- auto-select format according request headers
11-
- configurable compression options
12-
- content size threshold
13-
- compressed content detection
14-
- custom filtering
15-
- Cloudflare Workers and Deno Deploy compression check
16-
- works with [Node](https://nodejs.org/), [Deno](https://deno.com/), [Bun](https://bun.sh/) and edge runtime
9+
- all available compression formats (`zstd`, `brotli`, `gzip`, `deflate`)
10+
- ultra-fast and 100% type-safe
11+
- auto best format selection
12+
- streaming response support
13+
- configurable compression level and zlib options
14+
- double-compressed content protection
15+
- content size threshold and custom filtering
16+
- Cloudflare Workers and Deno Deploy runtime detection
17+
- works with [Node](https://nodejs.org/), [Deno](https://deno.com/) and [Bun](https://bun.sh/)
1718

1819
## Installation
1920

2021
```bash
21-
bun add github:vuolter/hono-compress
22+
bun add hono-compress
2223
```
2324

2425
## Usage
@@ -117,6 +118,6 @@ A function callback to state if response content should be compressed or not.
117118

118119
This project is a fork of [bun-compression](https://github.com/sunneydev/bun-compression), which itself is a fork of [elysia-compression](https://github.com/gusb3ll/elysia-compression).
119120

120-
Both projects were not maintained and lacked many of the features I was looking for, so I started with them, but ended up rewriting and expanding many parts.
121+
Both projects were not maintained and lacked many of the features I was looking for, so I started with them, but ended up rewriting and expanding many parts...
121122

122123
This project was also inspired by [hono/compress](https://github.com/honojs/hono), [expressjs/compression](https://github.com/expressjs/compression) and [elysia-compress](https://github.com/vermaysha/elysia-compress).

0 commit comments

Comments
 (0)