Skip to content

Commit

Permalink
Merge pull request #5 from jiyinyiyong/improve-docs
Browse files Browse the repository at this point in the history
adding example to README
  • Loading branch information
brenoferreira committed Oct 4, 2015
2 parents d262b5d + 1ed549f commit cc4892a
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions README.md
@@ -1,3 +1,29 @@
#Immutable Patch
Immutable Patch
====

Apply RFC 6902 style patches to Immutable.JS data structures, such as `Maps`, `Lists`, and `Sets`.
Apply RFC 6902 style patches to Immutable.JS data structures, such as `Maps`, `Lists`, and `Sets`.

### Getting Started

You may get the module via npm:

```
npm install immutablepatch
```

And apply JSON patches to an immutable JSON object:

```js
var Immutable = require('immutable');
var patch = require('immutablepatch');

var list = Immutable.fromJS([1, 2, [3, 4]]);
var ops = Immutable.fromJS([
{op: 'replace', path: '/2/1', value: 10}
]);

var result = patch(list, ops);
// var expected = Immutable.fromJS([1, 2, [3, 10]]);
```

You will probably need [`immutablediff`](https://github.com/intelie/immutable-js-diff) to generate diff operations.

0 comments on commit cc4892a

Please sign in to comment.