Chart.js/README.md

62 lines
3.1 KiB
Markdown
Raw Normal View History

2015-10-25 01:56:28 +02:00
[![](http://tannerlinsley.com/memes/chartjs.gif)](http://www.chartjs.org/docs/)
2015-10-25 01:55:34 +02:00
2015-01-03 04:56:58 +01:00
# Chart.js
2014-12-30 20:24:55 +01:00
2016-02-20 05:21:26 +01:00
[![Build Status](https://travis-ci.org/nnnick/Chart.js.svg?branch=master)](https://travis-ci.org/nnnick/Chart.js) [![Code Climate](https://codeclimate.com/github/nnnick/Chart.js/badges/gpa.svg)](https://codeclimate.com/github/nnnick/Chart.js) [![Chart.js on Slack](https://img.shields.io/badge/slack-Chart.js-blue.svg)](https://chartjs-slack-automation.herokuapp.com/)
2014-12-30 20:24:55 +01:00
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
2015-10-26 19:44:48 +01:00
## v1.0.2 Stable
2015-10-25 01:37:18 +02:00
- NPM: `npm install chart.js --save`
- Bower: `bower install Chart.js --save`
2015-10-26 19:43:50 +01:00
- CDN: https://cdnjs.cloudflare.com/ajax/libs/Chart.js/1.0.2/Chart.min.js
2015-10-25 01:37:18 +02:00
- Zip: [Download](https://github.com/nnnick/Chart.js/archive/master.zip)
2015-10-25 02:07:26 +02:00
[Examples](https://github.com/nnnick/Chart.js/tree/master/samples) | [Documentation](http://www.chartjs.org/docs/)
2015-10-25 01:43:51 +02:00
2015-10-25 01:26:10 +02:00
## v2.0 Beta
2015-09-30 19:59:09 +02:00
2015-10-25 01:37:18 +02:00
- Release: [2.0.0-beta](https://github.com/nnnick/Chart.js/releases/tag/2.0.0-beta)
- Zip: [Download](https://github.com/nnnick/Chart.js/archive/2.0.0-beta2.zip)
2015-10-25 01:37:18 +02:00
Documentation for v2.0 is currently located [here](http://nnnick.github.io/Chart.js/docs-v2/).
2015-10-25 01:43:51 +02:00
2015-10-25 01:37:18 +02:00
## v2.0 Bleeding-Edge
- Branch: [v2.0-dev](https://github.com/nnnick/Chart.js/tree/v2.0-dev)
- Zip: [Download](https://github.com/nnnick/Chart.js/archive/v2.0-dev.zip)
2015-10-25 01:43:51 +02:00
The next generation and release of Chart.js (v2.0) has been well under way this year and we are very close to releasing some amazing new features including, but not limited to:
- Rewritten, optimized, and unit-tested
- New and improved scales (log, time, linear, category, multiple scales)
2015-10-25 01:26:10 +02:00
- Improved Tooltips and tooltip callbacks for customization
- Improved responsiveness and resizing
2015-09-30 20:06:26 +02:00
- Powerful support for adding, removing, changing, and updating data on the fly
2015-10-25 01:26:10 +02:00
- Animations for everything, including all elements, colors and tooltips
- Powerful customization when you need it. Automatic and dynamic when you don't.
- Excellent support for modern frameworks and modular build systems.
2015-10-25 01:26:10 +02:00
- Even more extensible via new element controllers, core scale classes, combo chart support, and hook systems
- Bug fixes, stability improvements, etc.
#####Contributing to 2.0
Submit PR's to the v2.0-dev branch.
#####Building and Testing
2015-10-25 01:26:10 +02:00
`gulp build`, `gulp test`, `gulp watch --test`
2015-10-25 01:43:51 +02:00
#####v1.x Status: Feature Complete
2015-10-25 01:26:10 +02:00
v1.x is now considered feature complete. PR's for bug fixes are still extremely welcome. Any open PR's for v1.x features will need to be reconsidered, refactored and resubmitted for v2.x (if the feature has not already been implemented). For questions on new features refer to the docs in the v2.0-dev branch
2013-09-09 01:29:33 +02:00
2015-10-25 01:43:51 +02:00
## Bugs, Issues and Contributing
2013-10-17 00:28:41 +02:00
2015-01-02 00:49:10 +01: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/nnnick/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
2015-01-02 00:49:10 +01:00
## License
2014-10-01 18:18:47 +02:00
Chart.js is available under the [MIT license](https://github.com/nnnick/Chart.js/blob/master/LICENSE.md).