From 64c28f9feba2ea7c681b7081c3613ccbd299568b Mon Sep 17 00:00:00 2001
From: Ulf Gebhardt <ulf.gebhardt@webcraft-media.de>
Date: Mon, 20 Feb 2023 15:49:43 +0100
Subject: [PATCH] comment to explain what to override for custom brandings

---
 deployment/build-branded-images.sh | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/deployment/build-branded-images.sh b/deployment/build-branded-images.sh
index 04a724bb4..90e6729c0 100755
--- a/deployment/build-branded-images.sh
+++ b/deployment/build-branded-images.sh
@@ -1,5 +1,10 @@
 #!/bin/bash
 
+# for a branded version you should pass the following env variables:
+# CONFIGURATION - your configuration folder name
+# DOCKERHUB_ORGANISATION - your dockerhub organisation
+# OCELOT_VERSION - specify the specific tag to build upon e.g. 2.4.0-291
+
 # base setup
 SCRIPT_PATH=$(realpath $0)
 SCRIPT_DIR=$(dirname $SCRIPT_PATH)