From: Evert Timberg Date: Fri, 8 Jan 2021 04:56:01 +0000 (-0500) Subject: Add note about v3 dev code in readme (#8283) X-Git-Tag: v3.0.0-beta.8~5 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e63beb8c6da12fe1ae0666bb0a1dea7d9c77629a;p=thirdparty%2FChart.js.git Add note about v3 dev code in readme (#8283) * Add note about v3 dev code in readme * Adjust note based on feedback --- diff --git a/README.md b/README.md index 33e7b811c..e60e4451d 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,13 @@ ## 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/)