mirror of
https://github.com/chartjs/Chart.js.git
synced 2024-10-06 20:29:12 +02:00
69ab0d3e23
Change the linter in gulp tasks to be consistent with Code Climate results which are based on ESLint using .eslintrc options. However, defaults Code Climate rules are too strict, so turn as warnings the 'complexity' and 'max-statements' rules (other errors has been fixed). Note that the Gulp task name has been changed for `gulp lint`.
46 lines
2.1 KiB
Markdown
46 lines
2.1 KiB
Markdown
# Chart.js
|
|
|
|
[](https://travis-ci.org/chartjs/Chart.js) [](https://codeclimate.com/github/nnnick/Chart.js) [](https://coveralls.io/github/chartjs/Chart.js?branch=master)
|
|
|
|
[](https://chart-js-automation.herokuapp.com/)
|
|
|
|
*Simple HTML5 Charts using the canvas element* [chartjs.org](http://www.chartjs.org)
|
|
|
|
## Installation
|
|
|
|
You can download the latest version of [Chart.js on GitHub](https://github.com/chartjs/Chart.js/releases/latest) or just use these [Chart.js CDN](https://cdnjs.com/libraries/Chart.js) links.
|
|
|
|
To install via npm:
|
|
|
|
```bash
|
|
npm install chart.js --save
|
|
```
|
|
|
|
To Install via bower, please follow [these instructions](http://www.chartjs.org/docs/#getting-started-installation).
|
|
|
|
## Documentation
|
|
|
|
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).
|
|
|
|
## Contributing
|
|
|
|
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.
|
|
|
|
For support using Chart.js, please post questions with the [`chartjs` tag on Stack Overflow](http://stackoverflow.com/questions/tagged/chartjs).
|
|
|
|
## Building and Testing
|
|
|
|
To build, run `gulp build`.
|
|
|
|
To test, run `gulp test`.
|
|
|
|
To test against code standards, run `gulp lint`.
|
|
|
|
More information on building and testing can be found in [gulpfile.js](gulpfile.js).
|
|
|
|
Thanks to [BrowserStack](https://browserstack.com) for allowing our team to test on thousands of browsers.
|
|
|
|
## License
|
|
|
|
Chart.js is available under the [MIT license](http://opensource.org/licenses/MIT).
|