Skip to content

Commit 43e19e4

Browse files
committed
Update docs in README.md
1 parent deb9684 commit 43e19e4

File tree

1 file changed

+35
-36
lines changed

1 file changed

+35
-36
lines changed

README.md

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

33
> FusionCharts component for Vue
44
5-
This component allows to easily insert `FusionCharts` to your `Vue.js` projects and works in the `Vue.js` Way.
5+
FusionCharts component for Vue allows to easily include `FusionCharts` to your `Vue.js` projects.
66

77
## Installation
88

@@ -20,7 +20,7 @@ yarn add vue-fusioncharts
2020

2121
### manual
2222

23-
Download [`vue-fusioncharts.js`](https://github.com/fusioncharts/vue-fusioncharts/blob/feature/plugin-development/dist/vue-fusioncharts.js) and include in your HTML `<script>` tag.
23+
Download [`vue-fusioncharts.js`](https://github.com/fusioncharts/vue-fusioncharts/blob/feature/plugin-development/dist/vue-fusioncharts.js) and include it to an HTML `<script>` tag.
2424

2525
```html
2626
<script src='path/to/vue-fusioncharts/dist/vue-fusioncharts.js' type='text/javascript'></script>
@@ -50,7 +50,6 @@ Vue.use(VueFusionCharts, FusionCharts);
5050
```js
5151
var Vue = require('vue');
5252

53-
// require the UMD module
5453
var VueFusionCharts = require('vue-fusioncharts');
5554

5655
// import FusionCharts modules and resolve dependency
@@ -85,7 +84,7 @@ require(['vue', 'vue-fusioncharts', 'fusioncharts', 'charts'], function (Vue, Vu
8584
```
8685

8786
### Standalone / CDN
88-
If you are not using any bundler. You can just reference the file in a script tag. The library will be available in a global object named `VueFusionCharts`.
87+
If you are not using any bundler, you can refer the file in a script tag. The library will be available in a global object named `VueFusionCharts`.
8988

9089

9190
```html
@@ -116,46 +115,46 @@ If you are not using any bundler. You can just reference the file in a script ta
116115
</style>
117116

118117
<script>
119-
// Use VueFusionCharts component by calling the Vue.use() global method:
120-
Vue.use(VueFusionCharts);
121-
122-
// bootstrap the demo
123-
var chart = new Vue({
124-
el: '#chart',
125-
data: {
126-
pieChartConfig: {
127-
type: 'Pie2D',
128-
width: '500',
129-
height: '300',
130-
dataFormat: 'json',
131-
dataSource: {
132-
chart: {
133-
caption: 'Vue FusionCharts Sample',
134-
theme: 'fint'
118+
// Use VueFusionCharts component by calling the Vue.use() global method:
119+
Vue.use(VueFusionCharts);
120+
121+
// bootstrap the demo
122+
var chart = new Vue({
123+
el: '#chart',
124+
data: {
125+
pieChartConfig: {
126+
type: 'Pie2D',
127+
width: '500',
128+
height: '300',
129+
dataFormat: 'json',
130+
dataSource: {
131+
chart: {
132+
caption: 'Vue FusionCharts Sample',
133+
theme: 'fint'
134+
},
135+
data: [{value: 1.9}, {value: 2.3}, {value: 2.1}]
136+
},
137+
displayValue: 'nothing',
138+
events: {
139+
dataplotRollover: function (ev, props) {
140+
chart.displayValue = props.displayValue
141+
}
142+
}
135143
},
136-
data: [{value: 1.9}, {value: 2.3}, {value: 2.1}]
137-
},
138-
displayValue: 'nothing',
139-
events: {
140-
dataplotRollover: function (ev, props) {
141-
chart.displayValue = props.displayValue
142-
}
144+
displayValue: 'nothing'
143145
}
144-
},
145-
displayValue: 'nothing'
146-
}
147-
});
146+
});
148147
</script>
149148
</body>
150149
```
151-
See this examples live, click [here](https://jsfiddle.net/rohitcoolblog/5Lt720a9/).
150+
Click [here](https://jsfiddle.net/rohitcoolblog/5Lt720a9/) to view the live example.
152151

153152
## Register `vue-fusioncharts` component
154-
### Using `Vue.use` global method to register the component globally
153+
### Use `Vue.use` global method to register the component globally
155154
```js
156155
Vue.use(VueFusionCharts, FusionCharts, Charts);
157156
```
158-
### Using `Vue.component` method to register the component locally
157+
### Use `Vue.component` method to register the component locally
159158
```js
160159
// es6 style
161160
import {FCComponent} from 'vue-fusioncharts'
@@ -171,7 +170,7 @@ Vue.component('fusioncharts', FCComponent);
171170

172171
* `options`
173172

174-
Configuration needed to initialize FusionCharts. The complete list of supported configuration option can be found on [FusionCharts' API documentation](http://www.fusioncharts.com/dev/api/fusioncharts.html).
173+
Following configurations are required to initialize FusionCharts. The complete list of supported configuration option can be found in [FusionCharts' API documentation](http://www.fusioncharts.com/dev/api/fusioncharts.html).
175174

176175
<table>
177176
<thead>
@@ -230,7 +229,7 @@ Vue.component('fusioncharts', FCComponent);
230229
* Run `npm start` to start the dev server
231230
* Open `http://localhost:8080/` in your browser
232231

233-
```bash
232+
```sh
234233
$ git clone https://github.com/fusioncharts/vue-fusioncharts.git
235234
$ cd vue-fusioncharts
236235
$ npm install

0 commit comments

Comments
 (0)