Skip to content

Commit 4825a80

Browse files
authored
chore: Update README.md (#823)
1 parent 56897d4 commit 4825a80

File tree

1 file changed

+28
-21
lines changed

1 file changed

+28
-21
lines changed

README.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,46 @@
1-
[![build status](https://img.shields.io/travis/jerairrest/react-chartjs-2.svg?branch=master&style=flat-square)](https://travis-ci.org/jerairrest/react-chartjs-2)
2-
[![version](https://img.shields.io/npm/v/react-chartjs-2.svg?style=flat-square)](https://www.npmjs.com/package/react-chartjs-2)
3-
[![downloads](https://img.shields.io/npm/dm/react-chartjs-2.svg?style=flat-square)](https://npm-stat.com/charts.html?package=react-chartjs-2&from=2016-01-01)
4-
[![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](http://opensource.org/licenses/MIT)
5-
6-
# react-chartjs-2
7-
8-
React wrapper for [Chart.js](http://www.chartjs.org/docs/#getting-started)
9-
10-
## Getting started
11-
12-
### Install library with peer dependencies
1+
<div align="center">
2+
3+
<h1>React components for <a href="https://www.chartjs.org">Chart.js</a> 📊📈</h1>
4+
5+
Simple yet flexible charts for your React app
6+
7+
[![version](https://img.shields.io/npm/v/react-chartjs-2.svg)](https://www.npmjs.com/package/react-chartjs-2)
8+
[![downloads](https://img.shields.io/npm/dm/react-chartjs-2.svg)](https://www.npmjs.com/package/react-chartjs-2)
9+
[![license](https://shields.io/badge/license-MIT-green)](http://opensource.org/licenses/MIT)
10+
11+
<br />
12+
<a href="#quickstart">Quickstart</a>
13+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
14+
<a href="#examples">Examples</a>
15+
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
16+
<a href="https://slack.cube.dev/?ref=eco-react-chartjs">Slack</a>
17+
<br />
18+
<hr />
19+
</div>
20+
21+
## Quickstart
22+
23+
Install this library with peer dependencies:
1324

1425
```bash
1526
npm install --save react-chartjs-2 chart.js
16-
17-
# or
18-
19-
yarn add react-chartjs-2 chart.js
2027
```
2128

22-
###### We recommend using `chart.js ^3.0.0`
29+
We recommend using `chart.js@^3.0.0`.
2330

24-
### Usage
31+
Then, import and use individual components:
2532

2633
```jsx
2734
import { Doughnut } from 'react-chartjs-2';
2835

2936
<Doughnut data={...} />
3037
```
3138

32-
## Examples
39+
Need an API to fetch data? Consider [Cube](https://cube.dev/?ref=eco-react-chartjs), an open-source API for data apps.
3340

34-
Live: [reactchartjs.github.io/react-chartjs-2](https://reactchartjs.github.io/react-chartjs-2/#/)
41+
## Examples
3542

36-
See [these examples](example) for more information
43+
Please see [live examples](https://reactchartjs.github.io/react-chartjs-2/) or their [source code](example).
3744

3845
## Configure
3946

0 commit comments

Comments
 (0)