From 007cb6aa6d94413591dedd7db8427985d47138fd Mon Sep 17 00:00:00 2001 From: Wilson Lin Date: Wed, 14 Feb 2018 23:13:47 -0800 Subject: [PATCH] Make both README.md and installation.md clearer Address the ambiguity of "Selecting the Correct Build" section --- README.md | 18 +++++++++++++++--- docs/getting-started/installation.md | 6 +++--- 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b68b39008da..f914944e101 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,23 @@ To install via bower: bower install chart.js --save ``` -#### Selecting the Correct Build +### 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. +Chart.js provides two different builds for you to choose: `Stand-Alone Build`, `Bundled Build`. -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. +#### Stand-Alone Build +Files: +* `dist/Chart.js` +* `dist/Chart.min.js` + +The stand-alone build includes Chart.js as well as the color parsing library. If this version is used, you are required to include [Moment.js](http://momentjs.com/) before Chart.js for the functionality of the time axis. + +#### Bundled Build +Files: +* `dist/Chart.bundle.js` +* `dist/Chart.bundle.min.js` + +The bundled build includes Moment.js in a single file. You should use this version if you require time axes and want to include a single file. You should not use this build if your application already included Moment.js. Otherwise, Moment.js will be included twice which results in increasing page load time and possible version compatability issues. ## Documentation diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 613d7aa7a6c..ccc02ddc4b9 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -40,18 +40,18 @@ If you download or clone the repository, you must [build](../developers/contribu # Selecting the Correct Build -Chart.js provides two different builds that are available for your use. +Chart.js provides two different builds for you to choose: `Stand-Alone Build`, `Bundled Build`. ## Stand-Alone Build Files: * `dist/Chart.js` * `dist/Chart.min.js` -This version only includes Chart.js. 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 stand-alone build includes Chart.js as well as the color parsing library. If this version is used, you are required to include [Moment.js](http://momentjs.com/) before Chart.js for the functionality of the time axis. ## Bundled Build Files: * `dist/Chart.bundle.js` * `dist/Chart.bundle.min.js` -The bundled version includes Moment.js built into the same file. This version should be used if you wish to use time axes and want a single file to include. 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. +The bundled build includes Moment.js in a single file. You should use this version if you require time axes and want to include a single file. You should not use this build if your application already included Moment.js. Otherwise, Moment.js will be included twice which results in increasing page load time and possible version compatability issues.