Skip to content

Commit b2f7adc

Browse files
authored
Revamp the README.md and add link to the awesome list (#6096)
Integrate the upcoming awesome list and make our README.md welcome page more user friendly by displaying the Chart.js logo, adding the docs TOC and removing instructions that was already in the docs.
1 parent 93f4e6e commit b2f7adc

File tree

3 files changed

+23
-120
lines changed

3 files changed

+23
-120
lines changed

README.md

Lines changed: 22 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,31 @@
1-
# Chart.js
2-
3-
[![travis](https://img.shields.io/travis/chartjs/Chart.js.svg?style=flat-square&maxAge=60)](https://travis-ci.org/chartjs/Chart.js) [![coveralls](https://img.shields.io/coveralls/chartjs/Chart.js.svg?style=flat-square&maxAge=600)](https://coveralls.io/github/chartjs/Chart.js?branch=master) [![codeclimate](https://img.shields.io/codeclimate/maintainability/chartjs/Chart.js.svg?style=flat-square&maxAge=600)](https://codeclimate.com/github/chartjs/Chart.js) [![slack](https://img.shields.io/badge/slack-chartjs-blue.svg?style=flat-square&maxAge=3600)](https://chartjs-slack.herokuapp.com/)
4-
5-
*Simple HTML5 Charts using the canvas element* [chartjs.org](https://www.chartjs.org)
6-
7-
## Installation
8-
9-
You can download the latest version of Chart.js from the [GitHub releases](https://github.com/chartjs/Chart.js/releases/latest) or use a [Chart.js CDN](https://cdnjs.com/libraries/Chart.js).
10-
11-
To install via npm:
12-
13-
```bash
14-
npm install chart.js --save
15-
```
16-
17-
To install via bower:
18-
```bash
19-
bower install chart.js --save
20-
```
21-
22-
### Selecting the Correct Build
23-
24-
Chart.js provides two different builds for you to choose: `Stand-Alone Build`, `Bundled Build`.
25-
26-
#### Stand-Alone Build
27-
Files:
28-
* `dist/Chart.js`
29-
* `dist/Chart.min.js`
30-
31-
The stand-alone build includes Chart.js as well as the color parsing library. If this version is used, you are required to include [Moment.js](https://momentjs.com/) before Chart.js for the functionality of the time axis.
32-
33-
#### Bundled Build
34-
Files:
35-
* `dist/Chart.bundle.js`
36-
* `dist/Chart.bundle.min.js`
37-
38-
The bundled build includes Moment.js in a single file. You should use this version if you require time axes and want to include a single file. You should not use this build if your application already included Moment.js. Otherwise, Moment.js will be included twice which results in increasing page load time and possible version compatibility issues. The Moment.js version in the bundled build is private to Chart.js so if you want to use Moment.js yourself, it's better to use Chart.js (non bundled) and import Moment.js manually.
1+
<p align="center">
2+
<img src="https://www.chartjs.org/media/logo-title.svg"><br/>
3+
Simple yet flexible JavaScript charting for designers & developers
4+
</p>
5+
6+
<p align="center">
7+
<a href="https://www.chartjs.org/docs/latest/getting-started/installation.html"><img src="https://img.shields.io/github/release/chartjs/Chart.js.svg?style=flat-square&maxAge=600" alt="Downloads"></a>
8+
<a href="https://travis-ci.org/chartjs/Chart.js"><img src="https://img.shields.io/travis/chartjs/Chart.js.svg?style=flat-square&maxAge=600" alt="Builds"></a>
9+
<a href="https://coveralls.io/github/chartjs/Chart.js?branch=master"><img src="https://img.shields.io/coveralls/chartjs/Chart.js.svg?style=flat-square&maxAge=600" alt="Coverage"></a>
10+
<a href="https://github.com/chartjs/awesome"><img src="https://awesome.re/badge-flat2.svg" alt="Awesome"></a>
11+
<a href="https://chartjs-slack.herokuapp.com/"><img src="https://img.shields.io/badge/slack-chartjs-blue.svg?style=flat-square&maxAge=3600" alt="Slack"></a>
12+
</p>
3913

4014
## Documentation
4115

42-
You can find documentation at [www.chartjs.org/docs](https://www.chartjs.org/docs). The markdown files that build the site are available under `/docs`. Previous version documentation is available at [www.chartjs.org/docs/latest/developers/#previous-versions](https://www.chartjs.org/docs/latest/developers/#previous-versions).
16+
- [Introduction](https://www.chartjs.org/docs/latest/)
17+
- [Getting Started](https://www.chartjs.org/docs/latest/getting-started/)
18+
- [General](https://www.chartjs.org/docs/latest/general/)
19+
- [Configuration](https://www.chartjs.org/docs/latest/configuration/)
20+
- [Charts](https://www.chartjs.org/docs/latest/charts/)
21+
- [Axes](https://www.chartjs.org/docs/latest/axes/)
22+
- [Developers](https://www.chartjs.org/docs/latest/developers/)
23+
- [Popular Extensions](https://github.com/chartjs/awesome)
24+
- [Samples](https://www.chartjs.org/samples/)
4325

4426
## Contributing
4527

46-
Before submitting an issue or a pull request, please take a moment to look over the [contributing guidelines](https://github.com/chartjs/Chart.js/blob/master/docs/developers/contributing.md) first. For support using Chart.js, please post questions with the [`chartjs` tag on Stack Overflow](https://stackoverflow.com/questions/tagged/chartjs).
47-
48-
## Building
49-
Instructions on building and testing Chart.js can be found in [the documentation](https://github.com/chartjs/Chart.js/blob/master/docs/developers/contributing.md#building-and-testing).
50-
51-
## Thanks
52-
- [BrowserStack](https://browserstack.com) for allowing our team to test on thousands of browsers.
53-
- [@n8agrin](https://twitter.com/n8agrin) for the Twitter handle donation.
28+
Instructions on building and testing Chart.js can be found in [the documentation](https://github.com/chartjs/Chart.js/blob/master/docs/developers/contributing.md#building-and-testing). Before submitting an issue or a pull request, please take a moment to look over the [contributing guidelines](https://github.com/chartjs/Chart.js/blob/master/docs/developers/contributing.md) first. For support, please post questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/chartjs) with the `chartjs` tag.
5429

5530
## License
5631

docs/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,5 +51,5 @@
5151
* [Contributing](developers/contributing.md)
5252
* [Additional Notes](notes/README.md)
5353
* [Comparison Table](notes/comparison.md)
54-
* [Popular Extensions](notes/extensions.md)
54+
* [Popular Extensions](https://github.com/chartjs/awesome)
5555
* [License](notes/license.md)

docs/notes/extensions.md

Lines changed: 0 additions & 72 deletions
This file was deleted.

0 commit comments

Comments
 (0)