Skip to content

Commit

Permalink
Add engines field & add Node dependency to README
Browse files Browse the repository at this point in the history
Request, Response, and other Fetch API elements are only available in
Node v18.0.0 and later.

Also added a note to README to clarify the direct dependency on Node's
built-in zlib package.

Updated @major-tanya/itty-compression to v0.1.1
  • Loading branch information
MajorTanya committed Oct 14, 2023
1 parent e76955b commit f330284
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ compressed.

## How to use

**`itty-compression` directly depends on Node's zlib via importing `node:zlib`.**

Install with `npm install @major-tanya/itty-compression` (or your favoured alternative to npm).

Once installed, pick your compression algorithm, or use the flexible `negotiatedCompression` middleware.
Expand Down
7 changes: 5 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@major-tanya/itty-compression",
"version": "0.1.0",
"version": "0.1.1",
"main": "./dist/index.js",
"module": "./dist/index.mjs",
"types": "./dist/index.d.ts",
Expand Down Expand Up @@ -34,6 +34,9 @@
"url": "https://github.com/MajorTanya/itty-compression/issues"
},
"homepage": "https://github.com/MajorTanya/itty-compression#readme",
"engines": {
"node": ">=18"
},
"devDependencies": {
"@rollup/plugin-node-resolve": "^15.2.3",
"@rollup/plugin-terser": "^0.4.4",
Expand Down

0 comments on commit f330284

Please sign in to comment.