From b4244157fe371fba06ad47f689b9a09f263ea09f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Franc=C3=A9=20Wilke?= <france@uafrica.com>
Date: Fri, 28 Jan 2022 09:15:32 +0000
Subject: [PATCH] Update readme with new release instructions

---
 README.md | 37 +++++++++++++++++++++----------------
 1 file changed, 21 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index e048f92..9e8fbdc 100644
--- a/README.md
+++ b/README.md
@@ -2,19 +2,24 @@
 A set of utilities used by our Golang projects
 * [errors](./errors/README.md)
 
-## Creating a new tag
-When making changes, a new tag needs to be made in order to use the updated library in your project. First pull the tags, and check the latest version.
-
-`git pull --tags`
-
-`git tag`
-
-The output will be a list of tags. Create a new tag with the version number increased. E.g. if the last tag was `v1.2.7`, the new tag could be `v1.2.8`. Then push the tag.
-
-`git tag -a v1.2.8 -m "Tag v1.2.8"`
-
-`git push --tags`
-
-For your project, upgrade to the new version by running the `go get` command.
-
-`go get gitlab.com/uafrica/go-utils@v1.2.8`
\ No newline at end of file
+## Creating a new release
+When making changes, a new release needs to be made in order to use the updated library in your project.
+
+1. First, make sure your `uafrica-tools` repository is up to date (minimum at commit `442f62f0`):
+```
+git pull
+make install
+```
+
+2. After your changes have been merged to the `main` branch of `go-utils`, run the following command which will automatically create a new tag:
+```
+ua release 
+```
+and select project `uafrica/go-utils`
+
+3. For your project, upgrade to the new version by running the `go get` command and specifying the new tab:
+```
+go get gitlab.com/uafrica/go-utils@v1.6.0
+```
+
+**Note:** The release documentation can be found in GitLab, by navigating to the new tag. For example: https://gitlab.com/uafrica/go-utils/-/tags/v1.6.0
-- 
GitLab