Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update 'Versions' section in README.md due to v3 development #424

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Update 'Versions' section in README.md due to v3 development #424

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading