@jimp/plugin-blit - npm Package Compare versions

Comparing version 0.3.7 to 0.3.8

package.json

 {
   "name": "@jimp/plugin-blit",
-  "version": "0.3.7",
+  "version": "0.3.8",
   "description": "Blit 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,36 @@
-# @jimp/plugin-blit
+<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-blit</h1>
+  <p>Blit an image.</p>
+</div>
 
-Blit an image.
+> Blit - a data operation commonly used in computer graphics in which several bitmaps are combined into one using a boolean function.
+
+## Usage
+
+Blits a source image on to this image
+
+- @param {Jimp} src image to blit
+- @param {number} x the x position to blit the image
+- @param {number} y the y position to blit the image
+- @param {number} srcx (optional) the x position from which to crop the source image
+- @param {number} srcy (optional) the y position from which to crop the source image
+- @param {number} srcw (optional) the width to which to crop the source image
+- @param {number} srch (optional) the height to which to crop the source 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 parrot = await jimp.read('test/party-parrot.png');
+
+  image.blit(parrot, x, y);
+}
+
+main();
+```

No alert changes

Improved metrics

Total package byte prevSize

23322

increased by5.53%

Number of lines in readme file

37

increased by825%

Dependency changes

• Updated@jimp/utils@^0.3.8