From 0848bd452a81cd55383d72f485adeea07377e37a Mon Sep 17 00:00:00 2001 From: Lars Date: Wed, 26 Aug 2020 21:24:30 +0200 Subject: [PATCH] Describe new versioning in readme.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d83b254..6eeead5 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,6 @@ Script for Mozilla Firefox and Google Chrome browser to [send geocaches directly ## Version management -Changes must be done on the `master` branch. Once the changes are validated and ready to release, they can be merged to the `release` branch. The script version number needs to be raised before that merge (it needs be be larger than the existing version number on `release`) to trigger a rollout automatically. +Changes must be done on the `master` branch. Once the changes are validated and ready to release, they can be merged to the `release` branch. The script version number needs to be derived from the actual date of release and set accordingly in the scripts `@version` tag before that merge (it needs be be larger than the existing version number on `release`) to trigger a rollout automatically. The script download link on the [c:geo homepage](http://cgeo.org) as well as the update mechanism for the installed script directly targets the raw script on the `release` branch, which means after merging the changes to `release`, together with the required version number increase, users will see the update on the website and script hosts (e.g. Greasemonkey) will detect and notify users to update.