Skip to content

Commit 0d7fb3f

Browse files
authored
docs: add cube branding (#776)
* feat: add cube branding and change readme style * feat: change readme data * feat: change readme data part2 * feat: change readme data part3
1 parent d70edcf commit 0d7fb3f

File tree

1 file changed

+44
-18
lines changed

1 file changed

+44
-18
lines changed

README.md

Lines changed: 44 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
1-
<div align="center">
2-
<img width="256" heigth="256" src="/assets/vue-chartjs.png" alt="vue-chartjs logo">
3-
</div>
1+
# vue-chartjs
2+
3+
<img align="right" width="150" height="150" alt="vue-chartjs logo" src="/assets/vue-chartjs.png">
4+
5+
**vue-chartjs** is a wrapper for [Chart.js](https://github.com/chartjs/Chart.js) in vue. You can easily create reuseable chart components.
6+
7+
Supports Chart.js v3 and v2.
48

59
[![npm version](https://badge.fury.io/js/vue-chartjs.svg)](https://badge.fury.io/js/vue-chartjs)
610
[![codecov](https://codecov.io/gh/apertureless/vue-chartjs/branch/master/graph/badge.svg)](https://codecov.io/gh/apertureless/vue-chartjs)
7-
[![Build Status](https://travis-ci.org/apertureless/vue-chartjs.svg?branch=master)](https://travis-ci.org/apertureless/vue-chartjs)
11+
[![Build Status](https://img.shields.io/github/workflow/status/apertureless/vue-chartjs/CI.svg)](https://github.com/apertureless/vue-chartjs/actions)
812
[![Package Quality](http://npm.packagequality.com/shield/vue-chartjs.svg)](http://packagequality.com/#?package=vue-chartjs)
913
[![npm](https://img.shields.io/npm/dm/vue-chartjs.svg)](https://www.npmjs.com/package/vue-chartjs)
1014
[![Gitter chat](https://img.shields.io/gitter/room/TechnologyAdvice/Stardust.svg)](https://gitter.im/vue-chartjs/Lobby)
@@ -14,16 +18,22 @@
1418
[![Donate](assets/donate.svg)](https://www.paypal.me/apertureless/50eur)
1519
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/C0C1WP7C)
1620

17-
# vue-chartjs
18-
19-
**vue-chartjs** is a wrapper for [Chart.js](https://github.com/chartjs/Chart.js) in vue. You can easily create reuseable chart components.
20-
21-
Supports Chart.js v3 and v2.
22-
23-
## Demo & Docs
24-
25-
- 📺 [Demo](http://demo.vue-chartjs.org/)
26-
- 📖 [v3 Docs](http://vue-chartjs.org/)
21+
<br />
22+
<a href="#install">Install</a>
23+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
24+
<a href="#docs">Docs</a>
25+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
26+
<a href="#how-to-use">How to use</a>
27+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
28+
<a href="#migration-to-v4">Migration to v4</a>
29+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
30+
<a href="#demo">Demo</a>
31+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
32+
<a href="https://slack.cube.dev/?ref=eco-vue-chartjs">Slack</a>
33+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
34+
<a href="https://stackoverflow.com/questions/tagged/vue-chartjs">Stack Overflow</a>
35+
<br />
36+
<hr />
2737

2838
## Install
2939

@@ -39,6 +49,18 @@ npm i vue-chartjs chart.js
3949

4050
We recommend using `chart.js@^3.0.0`.
4151

52+
<hr />
53+
54+
Need an API to fetch data? Consider [Cube](https://cube.dev/?ref=eco-vue-chartjs), an open-source API for data apps.
55+
56+
<br />
57+
58+
[![supported by Cube](https://user-images.githubusercontent.com/986756/154330861-d79ab8ec-aacb-4af8-9e17-1b28f1eccb01.svg)](https://cube.dev/?ref=eco-vue-chartjs)
59+
60+
## Docs
61+
62+
- 📖 [v3 Docs](http://vue-chartjs.org/)
63+
4264
## How to use
4365

4466
This package works with version 2.x and 3.x of Vue.
@@ -49,7 +71,7 @@ Import the component.
4971
import { Bar } from 'vue-chartjs'
5072
```
5173

52-
For Vue 2 projects, you need to import from 'vue-chartjs/legacy'.
74+
For Vue 2 projects, you need to import from `vue-chartjs/legacy`.
5375

5476
```javascript
5577
import { Bar } from 'vue-chartjs/legacy'
@@ -238,7 +260,7 @@ import { Bar } from 'vue-chartjs'
238260
v4 — tree-shakable way:
239261

240262
```javascript
241-
import { Bar } from 'vue-chartjs/legacy'
263+
import { Bar } from 'vue-chartjs'
242264
import { Chart as ChartJS, Title, Tooltip, Legend, BarElement, CategoryScale, LinearScale } from 'chart.js'
243265

244266
ChartJS.register(Title, Tooltip, Legend, BarElement, CategoryScale, LinearScale)
@@ -249,7 +271,7 @@ Using the "lazy way" is okay to simplify the migration, but please consider usin
249271
Please note that typed chart components register their controllers by default, so you don't need to register them by yourself. For example, when using the Pie component, you don't need to register PieController explicitly.
250272

251273
```javascript
252-
import { Pie } from 'vue-chartjs/legacy'
274+
import { Pie } from 'vue-chartjs'
253275
import { Chart as ChartJS, Title, Tooltip, Legend, ArcElement, CategoryScale } from 'chart.js'
254276

255277
ChartJS.register(Title, Tooltip, Legend, ArcElement, CategoryScale)
@@ -353,7 +375,7 @@ export default {
353375
}
354376
```
355377

356-
v4 charts have data change watcher by default. v4 will update or re-render the chart if new data is passed.
378+
v4 charts have data change watcher by default. v4 will update or re-render the chart if new data is passed. Mixins have been removed.
357379

358380
v4:
359381

@@ -379,6 +401,10 @@ export default {
379401
</script>
380402
```
381403

404+
## Demo
405+
406+
- 📺 [Demo](http://demo.vue-chartjs.org/)
407+
382408
## Available Charts
383409

384410
### Bar Chart

0 commit comments

Comments
 (0)