From afb498f89c7887720da4c0a463527e309349fee8 Mon Sep 17 00:00:00 2001
From: Adam Jones <domdomegg+git@gmail.com>
Date: Sun, 19 May 2024 03:48:59 +0100
Subject: [PATCH] Add releases docs

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 6df5b76ee..d8ef22ca6 100644
--- a/README.md
+++ b/README.md
@@ -69,3 +69,13 @@ CMD [ "start", "--optimized" ]
 2. Install [Node.js](https://nodejs.org/)
 3. Edit files - usually in the `theme` folder, in particular the `components` subfolder
 4. Run `npm run build` to create [`dist/bluedot-keycloak-theme.jar`](./out/bluedot-keycloak-theme.jar) which can be installed as above
+
+## Releases
+
+Versions follow the [semantic versioning spec](https://semver.org/).
+
+To release:
+
+1. Use `npm version <major | minor | patch>` to bump the version
+2. Run `git push --follow-tags` to push with tags
+3. Wait for GitHub Actions to publish to GitHub releases.