Skip to content

Commit 00762bf

Browse files
authored
Update README.md
1 parent 48dad71 commit 00762bf

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![npm version](https://badge.fury.io/js/react-image-annotate.svg)](https://badge.fury.io/js/react-image-annotate)
44

5-
The best image/video annotation tool ever. [Check out the demo here](https://universaldatatool.github.io/react-image-annotate/).
5+
The best image/video annotation tool ever. [Check out the demo here](https://universaldatatool.github.io/react-image-annotate/). Or the [code sandbox here](https://codesandbox.io/s/react-image-annotate-example-38tsc?file=/src/App.js:0-403).
66

77
## Sponsors
88

@@ -23,16 +23,26 @@ The best image/video annotation tool ever. [Check out the demo here](https://uni
2323
`npm install react-image-annotate`
2424

2525
```javascript
26-
import ReactImageAnnotate from "react-image-annotate"
26+
import React from "react";
27+
import ReactImageAnnotate from "react-image-annotate";
2728

2829
const App = () => (
2930
<ReactImageAnnotate
30-
selectedImage="https://example.com/image1.png"
31-
taskDescription="# Draw region around each face\n\nInclude chin and hair."
32-
images={[{ src: "https://example.com/image1.png", name: "Image 1" }]}
33-
regionClsList={["Man Face", "Woman Face"]}
31+
labelImages
32+
regionClsList={["Alpha", "Beta", "Charlie", "Delta"]}
33+
regionTagList={["tag1", "tag2", "tag3"]}
34+
images={[
35+
{
36+
src: "https://placekitten.com/408/287",
37+
name: "Image 1",
38+
regions: []
39+
}
40+
]}
3441
/>
35-
)
42+
);
43+
44+
export default App;
45+
3646
```
3747

3848
To get the proper fonts, make sure to import the Inter UI or Roboto font, the

0 commit comments

Comments
 (0)