Chart.js/README.md

25 lines
1.3 KiB
Markdown
Raw Normal View History

2014-06-29 19:37:39 +02:00
# 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-06-29 19:37:39 +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.
2013-10-17 00:28:41 +02:00
2014-06-29 19:37:39 +02:00
## Contributing
New contributions to the library are welcome, just a couple of guidelines:
2013-03-19 17:22:03 +01:00
2014-06-29 19:37:39 +02:00
- Tabs for indentation, not spaces please.
- Please ensure you're changing the individual files in `/src`, not the concatenated output in the `Chart.js` file in the root of the repo.
- Please check that your code will pass `jshint` code standards, `gulp jshint` will run this for you.
- Please keep pull requests concise, and document new functionality in the relevant `.md` file.
- Consider whether your changes are useful for all users, or if creating a Chart.js extension would be more appropriate.