Initial commit

Author: jacwright

.gitignore

@@ -0,0 +1 @@
+node_modules

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jacob Wright
+
+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,66 @@
+# Differences.js
+
+Differences.js takes two values of any kind and returns true or false if they are different. It also returns the
+differences if both values are objects or both values are arrays. Differences.js is used to test if inmutable values
+change over time. It assumes the first value is the current value and the second one is the old value when calculating
+differences.
+
+## Usage
+
+### Basic
+
+To install Differences.js you can use npm.
+
+```
+npm install differences-js
+```
+
+To use Differences.js require it in your project.
+
+```
+var diff = require('differences-js');
+var value1 = 'foo';
+var value2 = 'bar';
+
+
+if (diff.values(value1, value2)) {
+  // the values are different
+} else {
+  // the values are the same
+}
+```
+
+The API only needs one method. `diff.values(currentValue, oldValue)`
+
+You can find the changes between two objects.
+
+```
+var changes = diff.values(obj1, obj2);
+
+if (changes) {
+  changes.forEach(function(change) {
+    var currentValue = obj1[change.name];
+    console.log(change.type, change.name, currentValue, change.oldValue);
+  });
+}
+```
+
+Each change in a list of object changes will have a `type` of `"new"`, `"updated"`, or `"deleted"`.
+
+You can find the changes between two arrays.
+
+```
+var splices = diff.values(array1, array2);
+
+if (splices) {
+  splices.forEach(function(splice) {
+    console.log(splice.index, splice.removed, splice.addedCount);
+  });
+}
+```
+
+## Contributions and Issues
+
+Please open a ticket for any bugs or feature requests.
+
+Contributions are welcome. Please fork and send a pull-request.

index.js

@@ -0,0 +1 @@
+module.exports = require('./src/diff');

package.json

@@ -0,0 +1,34 @@
+{
+  "name": "differences-js",
+  "version": "0.1.0",
+  "description": "Checks if there are any differences between two objects and provides the difference.",
+  "keywords": [
+    "templates",
+    "data-binding",
+    "javascript"
+  ],
+  "homepage": "http://github.com/chip-js/differences-js",
+  "author": {
+    "name": "Jacob Wright",
+    "email": "[email protected]",
+    "url": "http://github.com/jacwright"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/chip-js/differences-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/chip-js/differences-js/issues"
+  },
+  "licenses": {
+    "type": "MIT",
+    "url": "git://github.com/chip-js/differences-js/LICENSE"
+  },
+  "scripts": {
+    "test": "mocha test"
+  },
+  "devDependencies": {
+    "chai": "^3.4.1",
+    "mocha": "^2.3.3"
+  }
+}