Improve README.md#5274
Conversation
| #### 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 require to include [Moment.js](http://momentjs.com/) before Chart.js for the functionality of the time axis. |
There was a problem hiding this comment.
I would change the second sentence to "If this version is used, you are required to include Moment.js before Chart.js to enable the functionality of the time axis."
| 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 require 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 increasing page load time and possible version compatability issues. |
There was a problem hiding this comment.
"which results increasing page load" -> "which results in increasing page load"
|
Thanks @wla80, would you like to also update the documentation with the same changes? |
|
Hello @simonbrunel , you are welcome. I've already included the updates in installation.md. Thanks |
| 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. |
There was a problem hiding this comment.
I think it would be better to split this text in both following sub-sections, replacing the existing text.
There was a problem hiding this comment.
For some reason, I wasn't aware of the sub-sections. The text is split into sub-sections in both .md. Thanks for pointing out:)
Address the ambiguity of "Selecting the Correct Build" section
|
Thanks @wla80 |
Address the ambiguity of "Selecting the Correct Build" section
Improve the writing quality of "Selecting the Correct Build" section