Skip to content

Commit 69d6d80

Browse files
committed
Update README.
1 parent d1acfbd commit 69d6d80

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# jsondiffpatch-react
22

3-
- Originally forked from archived https://github.com/hero-guo/jsondiffpatch-for-react
3+
- Originally forked from archived
4+
https://github.com/hero-guo/jsondiffpatch-for-react
45
- Based on https://github.com/benjamine/jsondiffpatch
56

67
# 1. install
@@ -35,15 +36,19 @@ import JsonDiffReact from 'jsondiffpatch-react';
3536

3637
- `annotated` (bool)
3738

38-
This will render the original JSON delta in html, with annotations aside explaining the meaning of each part. This attempts to make the JSON delta format self-explained.
39+
This will render the original JSON delta in html, with annotations aside
40+
explaining the meaning of each part. This attempts to make the JSON delta
41+
format self-explained.
3942

4043
- `tips` (string)
4144

4245
Message that will displayed in case both elements are identical.
4346

4447
- `objectHash` (function)
4548

46-
Will be passed to _jsondiffpatch_ to improve array comparison performance, as described [here](https://github.com/benjamine/jsondiffpatch/blob/master/docs/arrays.md#an-example-using-objecthash).
49+
Will be passed to _jsondiffpatch_ to improve array comparison performance, as
50+
described
51+
[here](https://github.com/benjamine/jsondiffpatch/blob/master/docs/arrays.md#an-example-using-objecthash).
4752
Example:
4853

4954
```jsx
@@ -55,3 +60,8 @@ import JsonDiffReact from 'jsondiffpatch-react';
5560
}
5661
/>
5762
```
63+
64+
# Development notes
65+
66+
To publish to NPM, change the version number in `package.json` and `npm publish`
67+
once complete.

0 commit comments

Comments
 (0)