Skip to content

Commit 37879f0

Browse files
committed
chore: update README file
1 parent 09abe7d commit 37879f0

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
1-
# Coreui Vue Chartjs library
2-
![NPM](https://img.shields.io/badge/npm-1.0.0-brightgreen)
1+
## Coreui Vue Chartjs library
2+
![NPM](https://img.shields.io/badge/npm-1.0.1-brightgreen)
33
![Downloads](https://img.shields.io/npm/dm/@coreui/coreui-vue-chartjs.svg?style=flat-square)
44
![Chart.js](https://img.shields.io/badge/Chart.js-^2.9.3-brightgreen.svg)
55
![Vue](https://img.shields.io/badge/Vue-^2.6.10-brightgreen.svg)
66

7-
## CoreUI icons vue - CIcon component
7+
#### CoreUI icons vue - CIcon component
88

9-
Dedicated component used to implement [Chart.js](https://www.chartjs.org/) in Vue.js.
9+
Dedicated component used to implement [Chart.js](https://www.chartjs.org/) in Vue.js. You can find the **library documentation** [here](https://coreui.io/vue/docs/components/charts)
1010

11-
## Features
11+
#### Features
1212
- Implementation with ease - <b>You only need to pass 'datasets' prop and you have your chart working</b>. Optionally you can pass labels, options and plugins according to
13-
[Chart.js docs](https://www.chartjs.org/docs/latest/getting-started/usage.html)
14-
15-
The rest of chart.js configuration issues are already resolved,
13+
[Chart.js docs](https://www.chartjs.org/docs/latest/getting-started/usage.html). The rest of chart.js configuration issues are already resolved,
1614
- Chart will be rendered, even if you don't pass the labels, as empty labels will be generated automatically. You can also assign months or numeric indexes to labels (see prop description),
1715
- If you don't pass tooltip options, coreui-custom-tooltips, would be used by default. They are resolving the chart.js issue with tooltip beeing cut, when exceeding the canvas.
1816
- Dynamic updates of passed configuration. This feature makes your chart.js configuration automatically reactive to changes.
1917

20-
## Documentation
18+
#### Copyright and license
2119

22-
You can find the library documentation [here](https://coreui.io/vue/docs/components/charts)
20+
Copyright 2019 creativeLabs Łukasz Holeczek. Code released under the MIT license

0 commit comments

Comments
 (0)