Skip to content

Commit e23acf9

Browse files
committed
update README
1 parent 74f1be7 commit e23acf9

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,24 @@
22

33
A very simple echarts(v3.0 & v4.0) wrapper for react.
44

5-
[![Build Status](https://travis-ci.org/hustcc/echarts-for-react.svg?branch=master)](https://travis-ci.org/hustcc/echarts-for-react) [![Coverage Status](https://coveralls.io/repos/github/hustcc/echarts-for-react/badge.svg?branch=master)](https://coveralls.io/github/hustcc/echarts-for-react?branch=master) [![npm](https://img.shields.io/npm/v/echarts-for-react.svg)](https://www.npmjs.com/package/echarts-for-react) [![npm](https://img.shields.io/npm/dt/echarts-for-react.svg)](https://www.npmjs.com/package/echarts-for-react) [![npm](https://img.shields.io/npm/l/echarts-for-react.svg)](https://www.npmjs.com/package/echarts-for-react) ![echarts supported](https://img.shields.io/badge/echarts-%5E3.0.0%20%7C%7C%20%5E4.0.0-blue.svg) ![react supported](https://img.shields.io/badge/React-%3E%3D0.13.2%20%7C%7C%20%5E0.14%20%7C%7C%20%5E15.0.0%20%7C%7C%20%3E%3D16.0.0-blue.svg)
5+
[![Build Status](https://travis-ci.org/hustcc/echarts-for-react.svg?branch=master)](https://travis-ci.org/hustcc/echarts-for-react) [![Coverage Status](https://coveralls.io/repos/github/hustcc/echarts-for-react/badge.svg?branch=master)](https://coveralls.io/github/hustcc/echarts-for-react?branch=master) [![npm](https://img.shields.io/npm/v/echarts-for-react.svg)](https://www.npmjs.com/package/echarts-for-react) [![npm](https://img.shields.io/npm/dm/echarts-for-react.svg)](https://www.npmjs.com/package/echarts-for-react) [![npm](https://img.shields.io/npm/l/echarts-for-react.svg)](https://www.npmjs.com/package/echarts-for-react) ![echarts supported](https://img.shields.io/badge/echarts-%5E3.0.0%20%7C%7C%20%5E4.0.0-blue.svg) ![react supported](https://img.shields.io/badge/React-%3E%3D0.13.2%20%7C%7C%20%5E0.14%20%7C%7C%20%5E15.0.0%20%7C%7C%20%3E%3D16.0.0-blue.svg)
66

77
# 1. install
88

99
```sh
1010
npm install --save echarts-for-react
1111
```
1212

13-
How to run the demo:
13+
Then use it.
14+
15+
```js
16+
import ReactEcharts from 'echarts-for-react';
17+
18+
// render echarts option.
19+
<ReactEcharts option={this.getOption()} />
20+
```
21+
22+
You can run demo by:
1423

1524
```sh
1625
git clone git@github.com:hustcc/echarts-for-react.git
@@ -90,11 +99,11 @@ import 'echarts/lib/component/tooltip';
9099

91100
the echarts option config, can see [http://echarts.baidu.com/option.html#title](http://echarts.baidu.com/option.html#title).
92101

93-
- **`notMerge`** (required, object)
102+
- **`notMerge`** (optional, object)
94103

95104
when `setOption`, not merge the data, default is `false`. See [http://echarts.baidu.com/api.html#echartsInstance.setOption](http://echarts.baidu.com/api.html#echartsInstance.setOption).
96105

97-
- **`lazyUpdate`** (required, object)
106+
- **`lazyUpdate`** (optional, object)
98107

99108
when `setOption`, lazy update the data, default is `false`. See [http://echarts.baidu.com/api.html#echartsInstance.setOption](http://echarts.baidu.com/api.html#echartsInstance.setOption).
100109

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
"eslint-plugin-react": "^7.5.1",
7373
"file-loader": "^1.1.6",
7474
"jest": "^21.2.1",
75-
"jest-canvas-mock": "^0.0.2",
75+
"jest-canvas-mock": "^0.0.4",
7676
"jsx-loader": "^0.13.2",
7777
"react": "^15.5.0",
7878
"react-adsense": "^0.0.3",

0 commit comments

Comments
 (0)