]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
Add note about v3 dev code in readme (#8283)
authorEvert Timberg <evert.timberg+github@gmail.com>
Fri, 8 Jan 2021 04:56:01 +0000 (23:56 -0500)
committerGitHub <noreply@github.com>
Fri, 8 Jan 2021 04:56:01 +0000 (06:56 +0200)
* Add note about v3 dev code in readme

* Adjust note based on feedback

README.md

index 33e7b811c1ecbfa4fd5c5b41ee43f4d46584f36e..e60e4451d767105d2a3197e02719dffa9d095a98 100644 (file)
--- a/README.md
+++ b/README.md
 
 ## Documentation
 
+Currently, there are two versions of the library (2.9.4 and 3.x.x). Version 2 is the latest stable version while 3 is the next (currently beta) version. As such bear the following in mind:
+
+* Current docs points to version 2.9.4
+* Npm/CDN/etc point to version 2.9.4 (unless you explicitly set newer version, e.g. npm next)
+* Source currently points to 3.x.x version. 2.9.4 source is available [here](https://github.com/chartjs/Chart.js/tree/2.9)
+* Docs for version 3.x.x are available [here](https://www.chartjs.org/docs/master/)
+
 - [Introduction](https://www.chartjs.org/docs/latest/)
 - [Getting Started](https://www.chartjs.org/docs/latest/getting-started/)
 - [General](https://www.chartjs.org/docs/latest/general/)