Skip to content

Commit 8990051

Browse files
committed
Update readme
1 parent ced542a commit 8990051

File tree

2 files changed

+20
-30
lines changed

2 files changed

+20
-30
lines changed

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,22 @@
1-
# merge-images
1+
# merge-images-v2
22

33
> Easily compose images together without messing around with canvas
44
5-
[![Build Status](https://travis-ci.org/lukechilds/merge-images.svg?branch=master)](https://travis-ci.org/lukechilds/merge-images)
6-
[![Coverage Status](https://coveralls.io/repos/github/lukechilds/merge-images/badge.svg?branch=master)](https://coveralls.io/github/lukechilds/merge-images?branch=master)
7-
[![npm](https://img.shields.io/npm/dm/merge-images.svg)](https://www.npmjs.com/package/merge-images)
8-
[![npm](https://img.shields.io/npm/v/merge-images.svg)](https://www.npmjs.com/package/merge-images)
5+
[![Build Status](https://travis-ci.org/marcgodard/merge-images-v2.svg?branch=master)](https://travis-ci.org/marcgodard/merge-images-v2)
6+
[![Coverage Status](https://coveralls.io/repos/github/marcgodard/merge-images-v2/badge.svg?branch=master)](https://coveralls.io/github/marcgodard/merge-images-v2?branch=master)
7+
[![npm](https://img.shields.io/npm/dm/merge-images-v2.svg)](https://www.npmjs.com/package/merge-images-v2)
8+
[![npm](https://img.shields.io/npm/v/merge-images-v2.svg)](https://www.npmjs.com/package/merge-images-v2)
99

10-
Canvas can be kind of a pain to work with sometimes, especially if you just need a canvas context to do something relatively simple like merge some images together. `merge-images` abstracts away all the repetitive tasks into one simple function call.
10+
Canvas can be kind of a pain to work with sometimes, especially if you just need a canvas context to do something relatively simple like merge some images together. `merge-images-v2` abstracts away all the repetitive tasks into one simple function call.
1111

1212
Images can be overlaid on top of each other and repositioned. The function returns a Promise which resolves to a base64 data URI. Supports both the browser and Node.js.
1313

14+
This is an updated version of `merge-images` by Luke Childs with all libraries updated and multi operating system testing. I also removed `xo` as this linting caused many issues and I didn't like the way it worked. It also now works with the newest version of canvas.
15+
1416
## Install
1517

1618
```shell
17-
npm install --save merge-images
18-
```
19-
20-
or for quick testing:
21-
22-
```html
23-
<script src="https://unpkg.com/merge-images"></script>
19+
npm install --save merge-images-v2
2420
```
2521

2622
## Usage
@@ -34,7 +30,7 @@ With the following images:
3430
You can do:
3531

3632
```js
37-
import mergeImages from 'merge-images';
33+
import mergeImages from 'merge-images-v2';
3834

3935
mergeImages(['/body.png', '/eyes.png', '/mouth.png'])
4036
.then(b64 => document.querySelector('img').src = b64);
@@ -177,4 +173,4 @@ Canvas implementation to be used to allow usage outside of the browser. e.g Node
177173
178174
## License
179175
180-
MIT © Luke Childs
176+
MIT

package.json

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "merge-images",
3-
"version": "2.0.0",
4-
"description": "Easily compose images together without messing around with canvas",
2+
"name": "merge-images-v2",
3+
"version": "2.0.1",
4+
"description": "Easily compose images together without messing around with canvas, but has canvas for node",
55
"main": "dist/index.umd.js",
66
"module": "dist/index.es2015.js",
77
"files": [
@@ -16,28 +16,24 @@
1616
"prelint": "npm run build",
1717
"prepublish": "npm run build"
1818
},
19-
"xo": {
20-
"env": "browser",
21-
"extends": "xo-lukechilds"
22-
},
2319
"repository": {
2420
"type": "git",
25-
"url": "git+https://github.com/lukechilds/merge-images.git"
21+
"url": "git+https://github.com/marcgodard/merge-images-v2.git"
2622
},
2723
"keywords": [
2824
"compose",
2925
"merge",
26+
"rezise",
3027
"images",
3128
"without",
32-
"no",
3329
"canvas"
3430
],
35-
"author": "Luke Childs <[email protected]> (http://lukechilds.co.uk)",
31+
"author": "Originally: Luke Childs <[email protected]> (http://lukechilds.co.uk), Currently: Marc Godard <[email protected]> (https://marcgodard.com/)",
3632
"license": "MIT",
3733
"bugs": {
38-
"url": "https://github.com/lukechilds/merge-images/issues"
34+
"url": "https://github.com/marcgodard/merge-images-v2/issues"
3935
},
40-
"homepage": "https://github.com/lukechilds/merge-images",
36+
"homepage": "https://github.com/marcgodard/merge-images-v2",
4137
"dependencies": {},
4238
"devDependencies": {
4339
"ava": "^1.4.1",
@@ -46,11 +42,9 @@
4642
"canvas": "^2.5.0",
4743
"coveralls": "^3.0.0",
4844
"datauri": "^2.0.0",
49-
"eslint-config-xo-lukechilds": "^1.0.1",
5045
"nyc": "^14.1.1",
5146
"pify": "^4.0.1",
5247
"rollup": "^1.12.3",
53-
"rollup-plugin-buble": "^0.19.2",
54-
"xo": "^0.24.0"
48+
"rollup-plugin-buble": "^0.19.2"
5549
}
5650
}

0 commit comments

Comments
 (0)