📝 Update readme

This commit is contained in:
Jakub Juszczak
2016-06-26 16:03:38 +02:00
parent bab78b6991
commit 3018b5dc2b
3 changed files with 41 additions and 0 deletions

View File

@@ -2,6 +2,47 @@
> VueJS wrapper for ChartJs
## How to use
You need to import the base chart class and extend it. This gives much more flexibility when working with different data. You can pass the data over props or vue-resource.
```javascript
// CommitChart.js
import BarChart from '../BaseCharts/Bar'
export default BarChart.extend({
ready () {
this.render({
labels: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'],
datasets: [
{
label: 'GitHub Commits',
backgroundColor: '#f87979',
data: [40, 20, 12, 39, 10, 40, 39, 80, 40, 20, 12, 11]
}
]
})
}
})
```
Then simply import and use your own extended component and use it like a normal vue component
```javascript
import CommitChart from 'path/to/component/CommitChart'
```
## Available ChartJ
### Bar Chart
![Bar](src/assets/bar.png)
### Line Chart
![Bar](src/assets/line.png)
## Build Setup
``` bash