[New] add “whyNotEqual” at require(‘is-equal/why’) to provide an in…

…equality reason.

.jscs.json

@@ -122,7 +122,7 @@
 
 	"disallowArrowFunctions": true,
 
-	"disallowMultiLineTernary": true,
+	"disallowMultiLineTernary": false,
 
 	"validateOrderInObjectKeys": "asc-insensitive",
 

README.md

@@ -30,6 +30,19 @@ var timestamp = Date.now();
 assert.equal(isEqual(new Date(timestamp), new Date(timestamp)), true);
 ```
 
+## Want to know *why* two values are not equal?
+Will return an empty string if `isEqual` would return `true` - otherwise will return a non-empty string that hopefully explains the reasoning.
+
+```
+var whyNotEqual = require('is-equal/why');
+
+assert.equal(isEqual(1, 1), '');
+assert.equal(
+  isEqual({ a: 1 }, { a: 2 }),
+  'value at key "a" differs: numbers are different: 1 !== 2'
+);
+```
+
 ## Tests
 Simply clone the repo, `npm install`, and run `npm test`
 

package.json

@@ -7,11 +7,12 @@
 	"main": "index.js",
 	"scripts": {
 		"test": "npm run lint && npm run tests-only && npm run security",
-		"tests-only": "npm run test:native && npm run test:shimmed && npm run test:corejs",
-		"test:native": "node test/native.js",
-		"test:shimmed": "node test/shimmed.js",
-		"test:corejs": "node test/corejs.js",
-		"coverage": "covert test/native.js",
+		"tests-only": "npm run test:native && npm run test:why && npm run test:shimmed && npm run test:corejs",
+		"test:native": "node test/native",
+		"test:why": "node test/why",
+		"test:shimmed": "node test/shimmed",
+		"test:corejs": "node test/corejs",
+		"coverage": "covert test/native test/why",
 		"coverage-quiet": "covert test/native.js --quiet",
 		"lint": "npm run jscs && npm run eslint",
 		"jscs": "jscs *.js test/*.js",

test/corejs.js

@@ -2,4 +2,6 @@
 
 require('core-js');
 
+require('./why');
+
 require('./native');

test/shimmed.js

@@ -2,4 +2,6 @@
 
 require('es6-shim');
 
+require('./why');
+
 require('./native');