Skip to content

Commit 72a9947

Browse files
committed
Improved docs in README.md
1 parent 43e19e4 commit 72a9947

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

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

33
> FusionCharts component for Vue
44
5-
FusionCharts component for Vue allows to easily include `FusionCharts` to your `Vue.js` projects.
5+
The Vue-FusionCharts component lets you easily include FusionCharts in 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 it to an 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 in the HTML `<script>` tag.
2424

2525
```html
2626
<script src='path/to/vue-fusioncharts/dist/vue-fusioncharts.js' type='text/javascript'></script>
@@ -150,11 +150,11 @@ If you are not using any bundler, you can refer the file in a script tag. The li
150150
Click [here](https://jsfiddle.net/rohitcoolblog/5Lt720a9/) to view the live example.
151151

152152
## Register `vue-fusioncharts` component
153-
### Use `Vue.use` global method to register the component globally
153+
### Use the `Vue.use` global method to register the component globally
154154
```js
155155
Vue.use(VueFusionCharts, FusionCharts, Charts);
156156
```
157-
### Use `Vue.component` method to register the component locally
157+
### Use the `Vue.component` method to register the component locally
158158
```js
159159
// es6 style
160160
import {FCComponent} from 'vue-fusioncharts'
@@ -170,7 +170,7 @@ Vue.component('fusioncharts', FCComponent);
170170

171171
* `options`
172172

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).
173+
The commonly used configurations required to initialize FusionCharts are described in the table below. The complete list of supported configurations can be found in the [FusionCharts API documentation](http://www.fusioncharts.com/dev/api/fusioncharts.html).
174174

175175
<table>
176176
<thead>
@@ -192,42 +192,42 @@ Vue.component('fusioncharts', FCComponent);
192192
<td>width</td>
193193
<td>String/Number</td>
194194
<td><code>400</code></td>
195-
<td>Set the width in pixels or percent such as <code>640</code> or <code>'50%'</code>.</td>
195+
<td>Width in pixels (for example, <code>640</code>) or percent (for example, <code>50%</code>).</td>
196196
</tr>
197197
<tr>
198198
<td>height</td>
199199
<td>String/Number</td>
200200
<td><code>400</code></td>
201-
<td>Set the height in pixels or percent such as <code>640</code> or <code>'50%'</code>.</td>
201+
<td>Height in pixels (for example, <code>640</code>) or percent (for example, <code>50%</code>).</td>
202202
</tr>
203203
<tr>
204204
<td>id</td>
205205
<td>String</td>
206206
<td><code>chart-object-*</code></td>
207-
<td>This name is used to refer to the current chart instance after the chart has been created.</td>
207+
<td>Name of the current chart instance, after the chart has been created.</td>
208208
</tr>
209209
<tr>
210210
<td>dataFormat</td>
211211
<td>String</td>
212212
<td><code>JSON</code></td>
213-
<td>This is the name of the format of data passed to the dataSource option below. Currently, <code>FusionCharts</code> accepts only <code>JSON</code> and <code>XML</code> data.</td>
213+
<td>Format of the source data, passed to the <code>dataSource</code> attribute. Currently FusionCharts accepts data in the <code>JSON</code> and <code>XML</code> formats.</td>
214214
</tr>
215215
<tr>
216216
<td>dataSource</td>
217217
<td>String/Object</td>
218218
<td><code>none</code></td>
219-
<td>Provide the source of data and configuration of the chart. FusionCharts accepts data in the formats specified in dataFormats.</td>
219+
<td>Source data/source of the chart data and the chart configuration. Currently FusionCharts accepts data in the <code>JSON</code> and <code>XML</code> formats.</td>
220220
</tr>
221221
</tbody>
222222
</table>
223223

224224

225225

226226
## Development
227-
* Clone the repository
228-
* Install dependency
229-
* Run `npm start` to start the dev server
230-
* Open `http://localhost:8080/` in your browser
227+
* Clone the repository.
228+
* Install dependency.
229+
* Run `npm start` to start the dev server.
230+
* Open `http://localhost:8080/` in your browser.
231231

232232
```sh
233233
$ git clone https://github.com/fusioncharts/vue-fusioncharts.git

0 commit comments

Comments
 (0)