Update README.md
parent
5d4a434bf9
commit
e3cfe31322
71
README.md
71
README.md
|
@ -1,2 +1,73 @@
|
|||
# jsondiffpatch.net
|
||||
Json object diffs and patching ([jsondiffpatch](https://github.com/benjamine/jsondiffpatch) compatible)
|
||||
|
||||
## Usage
|
||||
|
||||
The full JSON patch document format is documented at https://github.com/benjamine/jsondiffpatch.
|
||||
|
||||
Note: Efficient array diff is currently NYI.
|
||||
|
||||
### Diff
|
||||
|
||||
Diff two json objects
|
||||
|
||||
``` C#
|
||||
var dmp = new JsonDiffPatch();
|
||||
var left = JToken.Parse(@"{ ""key"": false }");
|
||||
var right = JToken.Parse(@"{ ""key"": true }");
|
||||
|
||||
JToken patch = dmp.Diff(left, right);
|
||||
|
||||
Console.WriteLine(patch.ToString());
|
||||
|
||||
// Output:
|
||||
// {
|
||||
// "key": [false, true]
|
||||
// }
|
||||
```
|
||||
|
||||
### Patch
|
||||
|
||||
Patch a left object with a patch document
|
||||
|
||||
``` C#
|
||||
var dmp = new JsonDiffPatch();
|
||||
var left = JToken.Parse(@"{ ""key"": false }");
|
||||
var right = JToken.Parse(@"{ ""key"": true }");
|
||||
JToken patch = dmp.Diff(left, right);
|
||||
|
||||
var output = dmp.Patch(left, patch);
|
||||
|
||||
Console.WriteLine(output.ToString());
|
||||
|
||||
// Output:
|
||||
// {
|
||||
// "key": true
|
||||
// }
|
||||
```
|
||||
|
||||
### Unpatch
|
||||
|
||||
``` C#
|
||||
var dmp = new JsonDiffPatch();
|
||||
var left = JToken.Parse(@"{ ""key"": false }");
|
||||
var right = JToken.Parse(@"{ ""key"": true }");
|
||||
JToken patch = dmp.Diff(left, right);
|
||||
|
||||
var output = dmp.Unpatch(right, patch);
|
||||
|
||||
Console.WriteLine(output.ToString());
|
||||
|
||||
// Output:
|
||||
// {
|
||||
// "key": false
|
||||
// }
|
||||
```
|
||||
|
||||
## Installing
|
||||
nuget install jsondiffpatchdotnet
|
||||
|
||||
## Attributions
|
||||
* [jsondiffpatch](https://github.com/benjamine/jsondiffpatch)
|
||||
* [google-diff-patch-match](https://code.google.com/archive/p/google-diff-match-patch/)
|
||||
* [Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json/)
|
||||
|
|
Loading…
Reference in New Issue