From 2110d4dc2753c18f21e3ff3ff21c7e1cfea82290 Mon Sep 17 00:00:00 2001 From: Christian Mayer Date: Thu, 12 Dec 2024 11:44:59 +0100 Subject: [PATCH] Update 'Versions' section in README.md v3 This updates the 'Versions' section in the README.md file reflecting the `v3` development state. --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b2f5a64f..14c6a018 100644 --- a/README.md +++ b/README.md @@ -29,10 +29,17 @@ We look forward to your contributions! The lastest stable and released version stream is 2.x. -The latest developments are reflected within the `master` branch. We always try to have a robust state at the `master` branch, but be aware that breaking changes could come along. +The latest development points towards a Wegue version v3 supporting Vue 3. This development is reflected within the `master` branch. +Herewith some breaking changes come along. In case you have to remain on the v2.x version of Wegue you can use the latest release [v2.1.0](https://github.com/wegue-oss/wegue/releases/tag/v2.1.0) or to the maintenance development of v2 in the [v2 branch](https://github.com/wegue-oss/wegue/tree/v2). For a reasonable amount of time `v2` branch will be maintained. At least until there is an official `v3` release plus some additional buffer time. + +In case you want to upgrade an existing Wegue app from v2 to the current v3 development stream please have a look at the `upgrade-notes.md` file. + +We always try to have a robust state at the `master` branch, but be aware that breaking changes could come along. Especially in the phase of a major upgrade. In case you have to remain on the 1.x version of Wegue you can use the latest release [v1.2.1](https://github.com/wegue-oss/wegue/releases/tag/v1.2.1) or the maintenance development of v1 in the [v1 branch](https://github.com/wegue-oss/wegue/tree/v1). For a reasonable amount of time `v1` branch will be maintained. +Please consider to upgrade to Wegue v2 since v1 is quite old and uses a lot of outdated dependecies, which came to EOL. + In case you want to upgrade an existing Wegue app from v1 to the current v2 stream please have a look at the [upgrade-notes.md](upgrade-notes.md) file. ## Development