From fa629de87c6f6ebfd458c009f1b353147271336b Mon Sep 17 00:00:00 2001
From: jano3 <jano@uafrica.com>
Date: Wed, 13 Oct 2021 14:04:07 +0200
Subject: [PATCH] updated readme to include steps on creating a new tag

---
 README.md | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3a63300..e048f92 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
 # go-utils
 A set of utilities used by our Golang projects
-* [errors](./errors/README.md)
\ No newline at end of file
+* [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
-- 
GitLab