Skip to content

Commit

Permalink
Make both README.md and installation.md clearer
Browse files Browse the repository at this point in the history
Address the ambiguity of "Selecting the Correct Build" section
  • Loading branch information
Wilson Lin committed Feb 17, 2018
1 parent d6ce5c0 commit 1734d6c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ 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.
Chart.js provides two builds: `Chart.js`, `Chart.min.js`. Both `Chart.js` and `Chart.min.js` files include 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.

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.
Both `Chart.bundle.js` and `Chart.bundle.min.js` builds include 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

Expand Down
4 changes: 3 additions & 1 deletion docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ 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 builds: `Chart.js`, `Chart.min.js`. Both `Chart.js` and `Chart.min.js` files include 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.

Both `Chart.bundle.js` and `Chart.bundle.min.js` builds include 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.

## Stand-Alone Build
Files:
Expand Down

0 comments on commit 1734d6c

Please sign in to comment.