From bd1b605567bc48ab59ad8caf2efa913c2b5315c1 Mon Sep 17 00:00:00 2001
From: Tobias Brunner <tobias.brunner@vshn.ch>
Date: Thu, 5 Aug 2021 15:41:07 +0200
Subject: [PATCH] VT-910 Update README how to deploy theme

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

diff --git a/README.md b/README.md
index c7cdae9..0fff6ec 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,25 @@
 # keycloak-theme
 VSHN Keycloak IDP Theme
 
-## Local development
+## Local Development
 
 Run `docker compose up` to start a local keycloak with the vshn theme.
 
 The vshn theme is not automatically selected for the account application.
 This can be changed in the Admin Console by clicking on Realm Settings and then Theme.
+
+## Deploy to Your Instance
+
+1. Merge your Pull Request to master branch
+1. Tag it with
+    ```bash
+    git tag -am v1.x.y
+    git push --tags
+    ```
+1. This will trigger the GitHub Action and pushes the image to https://quay.io/repository/vshn/keycloak-theme?tab=tags
+1. Add the tag of the version to your extraInitContainers ([see codecentric helm chart documentation](https://github.com/codecentric/helm-charts/blob/master/charts/keycloak/README.md#providing-a-custom-theme))
+    ```yaml
+    extraInitContainers: |
+      - name: theme-provider
+        image: quay.io/vshn/keycloak-theme:v1.x.x
+    ```