diff --git a/README.md b/README.md
index b64a9130..35ebced6 100644
--- a/README.md
+++ b/README.md
@@ -3,79 +3,73 @@
![CircleCI](https://img.shields.io/circleci/project/github/zy410419243/mini-xmind/master.svg)
[![codecov](https://codecov.io/gh/zy410419243/mini-xmind/branch/master/graph/badge.svg)](https://codecov.io/gh/zy410419243/mini-xmind)
-![img](./docs/assets/demo.gif)
-
what you see in gif is the all what the repo do, just as title, a web tool for mini mind-mapping.
-online demo: https://zy410419243.github.io/mini-xmind/
+online demo: https://zy410419243.github.io/mini-xmind
-# usage
+## Screenshots
-```bash
-npm install mini-xmind --save-dev
-```
+![img](./docs/assets/demo.gif)
+
+## Usage
```javascript
import { Canvas, Toolbar } from 'mini-xmind';
-export class Demo extends React.Component {
- render = () => {
- const data = {
- CanvasPosition: { x: -67, y: 230 },
- BlockGroup: {
- 'block-623187': {
- x: 158,
- y: 256,
- },
- 'block-624018': {
- x: 367,
- y: 368,
- },
- 'block-73377': {
- x: 253,
- y: 525,
- },
- },
- TagGroup: {
- 'tag-626505': {
- x: 167,
- y: 284,
- style: { width: 100, height: 32 },
- editable: false,
- input: 'test',
- },
- 'tag-629962': {
- x: 405,
- y: 398,
- style: { width: 100, height: 32 },
- editable: false,
- input: 'test2',
- },
- 'tag-80986': {
- x: 286,
- y: 555,
- style: { width: 100, height: 32 },
- editable: false,
- input: 'test3',
- },
- },
- LineGroup: {
- 'line-77619': { fromKey: 'block-73377', toKey: 'block-623187' },
- 'line-592694': { fromKey: 'block-623187', toKey: 'block-624018' },
- },
- };
-
- return (
-
-
-
-
- );
- };
-}
+const data = {
+ CanvasPosition: { x: -67, y: 230 },
+ BlockGroup: {
+ 'block-623187': {
+ x: 158,
+ y: 256,
+ },
+ 'block-624018': {
+ x: 367,
+ y: 368,
+ },
+ 'block-73377': {
+ x: 253,
+ y: 525,
+ },
+ },
+ TagGroup: {
+ 'tag-626505': {
+ x: 167,
+ y: 284,
+ style: { width: 100, height: 32 },
+ editable: false,
+ input: 'test',
+ },
+ 'tag-629962': {
+ x: 405,
+ y: 398,
+ style: { width: 100, height: 32 },
+ editable: false,
+ input: 'test2',
+ },
+ 'tag-80986': {
+ x: 286,
+ y: 555,
+ style: { width: 100, height: 32 },
+ editable: false,
+ input: 'test3',
+ },
+ },
+ LineGroup: {
+ 'line-77619': { fromKey: 'block-73377', toKey: 'block-623187' },
+ 'line-592694': { fromKey: 'block-623187', toKey: 'block-624018' },
+ },
+};
+
+export default () => (
+
+
+
+
+);
```
-# develop
+## Development
```bash
git clone https://github.com/zy410419243/mini-xmind.git
@@ -89,15 +83,32 @@ npm start
http://localhost:9099
```
-# api
+## Example
+
+http://localhost:9099/
+
+## Test Case
+
+```
+npm test
+```
+
+## Coverage
+
+```
+npm run coverage
+```
+
+## API
-## Toolbar
+### Toolbar props
-There is no prop for it, just render it...
+There is no prop for now, just render it.
-## Canvas
+### Canvas props
-| Property | Description | Type | Default |
-| ----------- | -------------------------------- | ------------------------------------------------------------------------- | ------- |
-| data | What you want to paint in canvas | object, { BlockGroup: {}, TagGroup: {}, LineGroup: {} } | {} |
-| orientation | The direction of Line startting | enum, ['h', 'v', 'horizonal', 'vertical'], h == horizonal && v = vertical | h |
+| Property | Description | Type | Default |
+| ----------- | --------------------------------------------------- | -------------------------------------------------------------------------------------------- | ------- |
+| data | What you want to paint in canvas | object, { BlockGroup: {}, TagGroup: {}, LineGroup: {}, CanvasPosition: {} } | {} |
+| orientation | The direction of Line startting | enum, ['h', 'v', 'horizonal', 'vertical'], h == horizonal && v = vertical | h |
+| onChange | Return all data when dragging or typing in TagGroup | (dataCollector: { BlockGroup: {}, TagGroup: {}, LineGroup: {}, CanvasPosition: {} }) => void | - |