From 08ae9ddb5c979207ef1ac7d6620250dc91955060 Mon Sep 17 00:00:00 2001
From: Sergei Maertens <sergei@maykinmedia.nl>
Date: Tue, 17 Dec 2024 18:07:50 +0100
Subject: [PATCH] :pencil: Document minimal Helm installation steps

---
 README.md | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b6bf3fa..606865f 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,32 @@
 # Helm Charts
 
-TODO
+This repository contains the Helm charts for the invididual components and the umbrella
+chart for the full stack of components.
+
+The deployed components are:
+
+* GPP-App
+* GPP-Burgerportaal
+* GPP-Publicatiebank
+* Open Zaak
+
+## Requirements
+
+The requirements listed here are not included in the charts and you're responsible for
+provisioning them yourself.
+
+* PostgreSQL database (version 13 or higher, 16 (latest) is recommended)
+* An OpenID Connect identity provider for Single Sign On (optional)
+
+## Cheat sheet
+
+```bash
+helm repo add gpp-woo https://GPP-Woo.github.io/charts
+helm repo update
+helm install \
+    -f myvalues.yml \
+    my-gpp-woo \
+    gpp-woo/gpp-stack
+```
+
+Assuming a values file ``myvalues.yml`` was created.