Chart.js/README.md

37 lines
1.7 KiB
Markdown
Raw Normal View History

2016-04-24 23:33:25 +02:00
# Chart.js
2014-12-30 20:24:55 +01:00
2016-04-25 04:12:15 +02:00
[![Build Status](https://travis-ci.org/chartjs/Chart.js.svg?branch=master)](https://travis-ci.org/chartjs/Chart.js) [![Code Climate](https://codeclimate.com/github/nnnick/Chart.js/badges/gpa.svg)](https://codeclimate.com/github/nnnick/Chart.js) [![Coverage Status](https://coveralls.io/repos/github/chartjs/Chart.js/badge.svg?branch=master)](https://coveralls.io/github/chartjs/Chart.js?branch=master)
2014-12-30 20:24:55 +01:00
2016-04-17 01:48:55 +02:00
[![Chart.js on Slack](https://img.shields.io/badge/slack-Chart.js-blue.svg)](https://chartjs-slack-automation.herokuapp.com/)
2014-06-29 19:37:39 +02:00
*Simple HTML5 Charts using the canvas element* [chartjs.org](http://www.chartjs.org)
2013-09-09 01:29:33 +02:00
2016-04-17 01:48:55 +02:00
## Installation
2015-09-30 23:32:16 +02:00
2016-04-17 01:48:55 +02:00
To download a zip, go to the Chart.js on Github
2015-09-30 23:32:16 +02:00
2016-04-17 01:48:55 +02:00
To install via npm / bower:
2015-09-30 23:32:16 +02:00
2016-04-17 01:48:55 +02:00
```bash
npm install chart.js --save
bower install Chart.js --save
```
2016-05-08 22:19:36 +02:00
CDN: https://cdnjs.cloudflare.com/ajax/libs/Chart.js/2.1.2/Chart.min.js
2015-09-30 23:32:16 +02:00
2014-06-29 19:37:39 +02:00
## Documentation
2013-09-09 01:29:33 +02:00
You can find documentation at [www.chartjs.org/docs](http://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/#notes-previous-versions](http://www.chartjs.org/docs/#notes-previous-versions).
2013-09-09 01:29:33 +02:00
2016-04-17 01:48:55 +02:00
## Contributing
2013-10-17 00:28:41 +02:00
2016-04-25 15:21:39 +02:00
Before submitting an issue or a pull request to the project, please take a moment to look over the [contributing guidelines](https://github.com/chartjs/Chart.js/blob/master/CONTRIBUTING.md) first.
2013-10-17 00:28:41 +02:00
2015-01-03 16:30:58 +01:00
For support using Chart.js, please post questions with the [`chartjs` tag on Stack Overflow](http://stackoverflow.com/questions/tagged/chartjs).
2013-10-17 00:28:41 +02:00
2016-04-17 01:48:55 +02:00
## Building and Testing
`gulp build`, `gulp test`
2015-01-02 00:49:10 +01:00
## License
2014-10-01 18:18:47 +02:00
2015-01-02 00:49:10 +01:00
Chart.js is available under the [MIT license](http://opensource.org/licenses/MIT).