@jimp/plugin-mask - npm Package Compare versions

Comparing version 0.3.7 to 0.3.8

package.json

 {
   "name": "@jimp/plugin-mask",
-  "version": "0.3.7",
+  "version": "0.3.8",
   "description": "mask an image.",
@@ -19,3 +19,3 @@ "main": "dist/index.js",
   "dependencies": {
-    "@jimp/utils": "^0.3.7"
+    "@jimp/utils": "^0.3.8"
   },
@@ -27,3 +27,4 @@ "peerDependencies": {
     "access": "public"
-  }
+  },
+  "gitHead": "e04f0bb3d755b18136b00ccefc02497b7581a828"
 }

README.md

@@ -1,3 +0,28 @@
-# @jimp/plugin-mask
+<div align="center">
+  <a href="https://intuit.github.io/Ignite/">
+    <img width="200" height="200"
+      src="https://s3.amazonaws.com/pix.iemoji.com/images/emoji/apple/ios-11/256/crayon.png">
+  </a>
+  <h1>@jimp/plugin-mask</h1>
+  <p>mask an image with another image.</p>
+</div>
 
-mask an image.
+Masks a source image on to this image using average pixel colour. A completely black pixel on the mask will turn a pixel in the image completely transparent.
+
+## Usage
+
+- @param {Jimp} src the source Jimp instance
+- @param {number} x the horizontal position to blit the image
+- @param {number} y the vertical position to blit the image
+- @param {function(Error, Jimp)} cb (optional) a callback for when complete
+
+```js
+import jimp from 'jimp';
+
+async function main() {
+  const image = await jimp.read('test/image.png');
+  const mask = await jimp.read('test/mask.png');
+
+  image.mask(mask);
+}
+```

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

Improved metrics

Total package byte prevSize

15437

increased by6.18%

Number of lines in readme file

29

increased by625%

Dependency changes

• Updated@jimp/utils@^0.3.8