Initial commit with node package and README base

Author: GuilhermeRossato

.gitignore

@@ -0,0 +1,59 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Guilherme Rossato
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,48 @@
+## image-area-diff
+
+A simple and straightforward JavaScript library to compare images conditionally by areas.
+
+Used to detect differences between image areas, not everywhere in the image. Features whitelisting spaces that are supposed to be different and only mark differences in the other parts of the image.
+
+Especially useful to filter 'dinamic' parts of screenshots and compare the rest. Also features blacklisting of areas to work conditionally the other way.
+
+### API
+
+```js
+var imageDiff = require('image-area-dif');
+
+var numDiffPixels = imageDiff(
+    "threshold": 0.1,
+    "compare": ["old.png", "new.png"],
+    "whitelist": [
+        {left: 0, top: 0, width: 600, height: 100}, // whitelist the header of the image (left,top,width,height variant)
+        {left: 100, top: 100, right:400, bottom: 100}, // whitelist the center of the footer (left,top,right,bottom variant)
+        {x: 120, y: 125}, // whitelist a pixel (x,y variant)
+        {x: 10, y: 130, radius: 10}, // whitelist a circular area (x,y,radius variant)
+    ],
+    "output": "diff.png" // Optional, save difference to file
+);
+```
+
+### Install
+
+Install with NPM:
+
+```bash
+npm install image-area-diff
+```
+
+To build a browser-compatible version, clone the repository locally, then run:
+
+```bash
+npm install -g browserify
+browserify -s image-area-diff index.js > image-area-diff.js
+```
+
+To build a binary executable version, use the API to configure the usage as you like, then:
+```bash
+npm install -g pkg
+pkg index.js --target host --output app.exe
+```
+
+### [Changelog](https://github.com/GuilhermeRossato/image-area-diff/releases)

package.json

@@ -0,0 +1,37 @@
+{
+  "name": "image-area-diff",
+  "version": "0.9.0",
+  "description": "An efficient JavaScript library used to conditionally compare pixel-level areas in PNG images",
+  "main": "index.js",
+  "scripts": {
+    "test": "tap test/test.js -t 100"
+  },
+  "dependencies": {
+    "pixelmatch": "^4.0.2"
+  },
+  "devDependencies": {
+    "eslint": "^4.18.1",
+    "eslint-config-mourner": "^2.0.3",
+    "tap": "^11.1.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/GuilhermeRossato/image-area-diff.git"
+  },
+  "keywords": [
+    "test",
+    "image",
+    "comparision",
+    "area",
+    "dif"
+  ],
+  "engines": {
+    "node": ">=5.5.1"
+  },
+  "author": "Guilherme Rossato <guilhermrossato@gmail.com> (https://github.com/GuilhermeRossato)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/GuilhermeRossato/image-area-diff/issues"
+  },
+  "homepage": "https://github.com/GuilhermeRossato/image-area-diff#readme"
+}