Skip to content
Browse files

working on readme, correct version in package.json

  • Loading branch information...
1 parent 6a98570 commit 21d937d32e8fcf7923ac502206b480683425d720 @Gottox committed Aug 30, 2012
Showing with 21 additions and 2 deletions.
  1. +20 −1 README.md
  2. +1 −1 package.json
View
21 README.md
@@ -3,7 +3,26 @@
### ObjDiff
-This node library implements a very simple diff algorithm for javascript/json objects
+This node library implements a very simple diff algorithm for javascript/json objects.
+
+An example diff object looks like:
+
+```
+> objdiff({a:2,c:1},{b:2,c:2})
+{ a:
+ { '$changed': true,
+ '-': 2 },
+ c:
+ { '$changed': true,
+ '-': 1,
+ '+': 2 },
+ b:
+ { '$changed': true,
+ '+': 2 } }
+```
+
+every value, that has changed is represented by an object with the key-value
+pair ```$changed: true```.
## Installation
View
2 package.json
@@ -1,6 +1,6 @@
{
"name": "objdiff",
- "version": "0.1",
+ "version": "0.1.0",
"author": "Enno Boland <eb@s01.de>",
"description": "Diffs two javascript objects.",
"main": "./index",

0 comments on commit 21d937d

Please sign in to comment.
Something went wrong with that request. Please try again.