Chart.js/README.md

18 lines
1.4 KiB
Markdown
Raw Normal View History

2014-12-29 04:18:55 +01:00
# Chart.js[![Code Climate](https://codeclimate.com/github/nnnick/Chart.js/badges/gpa.svg)](https://codeclimate.com/github/nnnick/Chart.js)
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
2014-06-29 19:37:39 +02:00
## Documentation
2013-09-09 01:29:33 +02:00
2014-09-04 19:48:37 +02:00
You can find documentation at [chartjs.org/docs](http://www.chartjs.org/docs/). The markdown files that build the site are available under `/docs`. Please note - in some of the json examples of configuration you might notice some liquid tags - this is just for the generating the site html, please disregard.
2013-09-09 01:29:33 +02:00
2014-06-29 19:37:39 +02:00
## License
2013-10-17 00:28:41 +02:00
2014-06-29 19:37:39 +02:00
Chart.js is available under the [MIT license](http://opensource.org/licenses/MIT).
2013-10-17 00:28:41 +02:00
2014-06-29 19:37:39 +02:00
## Bugs & issues
2013-10-17 00:28:41 +02:00
2014-06-29 19:37:39 +02:00
When reporting bugs or issues, if you could include a link to a simple [jsbin](http://jsbin.com) or similar demonstrating the issue, that'd be really helpful.
2014-10-01 18:18:47 +02:00
This project is modular and supports separately-maintained new chart types. This project's scope includes only the chart types included. New chart types should be created and maintained in separate repositories. We may consider linking to them from this project if they incude passing build tests and have complete documentation. Please discuss new or "missing" chart types in the [Chart.js User Discussion](https://groups.google.com/forum/#!forum/chartjs-user-discussion) Google Group and not in Issues. For more information, please also see the CONTRIBUTING file.