Skip to content

Commit 4d2fdfa

Browse files
committed
Basic readme for usage
1 parent 55bbafd commit 4d2fdfa

1 file changed

Lines changed: 28 additions & 1 deletion

File tree

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,28 @@
1-
diff3
1+
# diff3
2+
3+
## Usage
4+
```js
5+
var diff3Merge = require('diff3');
6+
var a = ['a', 'text', 'file'];
7+
var o = ['a', 'test', 'file'];
8+
var b = ['a', 'toasty', 'filtered', 'file'];
9+
var diff3 = diff3Merge(a, o, b);
10+
```
11+
12+
## Output
13+
```JSON
14+
[{
15+
"ok": ["a"]
16+
}, {
17+
"conflict": {
18+
"a": ["text"],
19+
"aIndex": 1,
20+
"o": ["test"],
21+
"oIndex": 1,
22+
"b": ["toasty", "filtered"],
23+
"bIndex": 1
24+
}
25+
}, {
26+
"ok": ["file"]
27+
}]
28+
```

0 commit comments

Comments
 (0)