Skip to content

Commit a06524f

Browse files
committed
doc: update README
1 parent 3d279bb commit a06524f

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Compare HTML and generate the differences in either a unified view or a side-by-
1010
pnpm add @armantang/html-diff
1111
```
1212

13-
## Quick Start
13+
## Usage
1414

1515
```js
1616
import '@armantang/html-diff/dist/index.css'
@@ -62,3 +62,7 @@ interface HtmlDiffOptions {
6262
}>
6363
}
6464
```
65+
66+
## Synchronized scrolling
67+
68+
In the sideBySideContents, some elements have the `data-seq` attribute. We can use this to implement synchronized scrolling. [Click to see the demo.](https://github.com/Arman19941113/html-diff/blob/master/examples/basic/src/components/SideBySide.jsx)

0 commit comments

Comments
 (0)