]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
Add a note about selecting the correct build that describes what the bundled versions do. 2595/head
authorEvert Timberg <evert.timberg+github@gmail.com>
Thu, 19 May 2016 01:31:51 +0000 (21:31 -0400)
committerEvert Timberg <evert.timberg+github@gmail.com>
Thu, 19 May 2016 01:31:51 +0000 (21:31 -0400)
docs/00-Getting-Started.md

index 6723d8669b944728d0ec120b63e7ea8ee3a8c029..1758fbbef16de350899d9ffbe73302987b151f3a 100644 (file)
@@ -6,8 +6,8 @@ anchor: getting-started
 ### Download Chart.js
 
 To download a zip, go to [Chart.js on Github](https://github.com/chartjs/Chart.js) and choose the version that is right for your application.
-* [Standard build](https://raw.githubusercontent.com/chartjs/Chart.js/v2.0-dev/dist/Chart.js) (~31kB gzipped)
-* [Bundled with Moment.js](https://raw.githubusercontent.com/chartjs/Chart.js/v2.0-dev/dist/Chart.bundle.js) (~45kB gzipped)
+* [Standard build](https://raw.githubusercontent.com/chartjs/Chart.js/master/dist/Chart.js) (~31kB gzipped)
+* [Bundled with Moment.js](https://raw.githubusercontent.com/chartjs/Chart.js/master/dist/Chart.bundle.js) (~45kB gzipped)
 * [CDN Versions](https://cdnjs.com/libraries/Chart.js)
 
 To install via npm / bower:
@@ -19,6 +19,12 @@ npm install chart.js --save
 bower install Chart.js --save
 ```
 
+### Selecting the Correct Build
+
+Chart.js provides two different builds that are available for your use. The `Chart.js` and `Chart.min.js` files include Chart.js and the accompanying color parsing library. If this version is used and you require the use of the time axis, [Moment.js](http://momentjs.com/) will need to be included before Chart.js.
+
+The `Chart.bundle.js` and `Chart.bundle.min.js` builds include Moment.js in a single file. This version should be used if you require time axes and want a single file to include, select this version. Do not use this build if your application already includes Moment.js. If you do, Moment.js will be included twice, increasing the page load time and potentially introducing version issues.
+
 ### Installation
 
 To import Chart.js using an old-school script tag: