jimp-compact - npm Package Compare versions

Comparing version 0.16.1-1 to 0.16.1-2

dist/jimp.d.ts

@@ -50,2 +50,2 @@ /**
 
-export = Jimp;
+export default Jimp;

package.json

 {
   "name": "jimp-compact",
+  "version": "0.16.1-2",
   "description": "Compact version of Jimp",
   "repository": "unjs/jimp-compact",
   "license": "MIT",
+  "main": "./dist/jimp.cjs",
+  "types": "./dist/jimp.d.ts",
   "files": [
@@ -10,6 +13,5 @@ "dist",
   ],
-  "main": "./dist/jimp.cjs",
-  "types": "./dist/jimp.d.ts",
   "scripts": {
     "build": "jiti ./build",
+    "prepack": "yarn build",
     "test": "node ./test/index.js"
@@ -25,4 +27,3 @@ },
     "typescript": "^4.4.3"
-  },
-  "version": "0.16.1-1"
+  }
 }

README.md

@@ -1,7 +0,2 @@
-<div align="center">
-  <img width="200" height="200"
-    src="https://s3.amazonaws.com/pix.iemoji.com/images/emoji/apple/ios-11/256/crayon.png">
-  <h1>Jimp Compact</h1>
-  <p>Compact Version of <a href="https://github.com/oliver-moran/jimp">Jimp</a></p>
-</div>
+# ✏️ Jimp Compact
 
@@ -11,20 +6,40 @@ <!-- [![automated](https://flat.badgen.net/badge/publish/automated/green)](#) -->
 [![npm version](https://flat.badgen.net/npm/v/jimp-compact)](https://www.npmjs.com/package/jimp-compact)
-[![npm downloads](https://flat.badgen.net/npm/dt/jimp-compact)](https://www.npmjs.com/package/jimp-compact)
+[![npm downloads](https://flat.badgen.net/npm/dm/jimp-compact)](https://www.npmjs.com/package/jimp-compact)
 [![install size](https://flat.badgen.net/packagephobia/install/jimp-compact)](https://packagephobia.now.sh/result?p=jimp-compact)
 
-🔥 Compiled using [vercel/ncc](https://github.com/vercel/ncc)
+> Lightweight version of [Jimp](https://github.com/oliver-moran/jimp) compiled with [vercel/ncc](https://github.com/vercel/ncc)
 
 ## Why?
 
-This package has **32x** smaller install size with **all** features of original jimp (Jimp install size is [~16.3MB](https://packagephobia.now.sh/result?p=jimp))
+This package has **27x** smaller install size with **all** features of original jimp (Jimp install size is [~33.8MB](https://packagephobia.now.sh/result?p=jimp)) by bundling all `node_modules` and removing extra files.
 
-
 ## Usage
 
-Install and import/require `jimp-compact` instead of `jimp` NPM package.
+Install and import/require `jimp-compact` instead of `jimp` npm package.
 
+```sh
+# npm
+npm i jimp-compact
+
+# yarn
+yarn add jimp-compact
+```
+
+```js
+// ESM
+import Jimp from 'jimp-compact'
+
+// CJS
+const Jimp = require('jimp-compact')
+```
+
 See [jimp docs](https://github.com/oliver-moran/jimp/tree/master/packages/jimp) for full usage.
 
+## Known Issues
+
+In order to make typescript working, you need to (also) install `jimp` in `devDependencies`!
+Track issue via [#39](https://github.com/unjs/jimp-compact/issues/39) and [#42](https://github.com/unjs/jimp-compact/issues/52).
+
 ## License
 
 MIT - Based on [Jimp](https://github.com/oliver-moran/jimp/blob/master/LICENSE)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1295788

increased by0.02%

Number of lines in readme file

45

increased by50%

Number of medium supply chain risk alerts

4

decreased by-20%

No dependency changes