From cffe69cbd2291c72929e492124847920d56413b3 Mon Sep 17 00:00:00 2001
From: NicolasHorde <nicolas.horde@cobolcloud.io>
Date: Mon, 24 Mar 2025 20:08:29 +0100
Subject: [PATCH] feat: adding readme

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5956bc3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# 🧠 Typebot – Helm Chart
+
+This Helm Chart deploys a **self-hosted Typebot** instance on Kubernetes with:
+
+- **PostgreSQL** as the main database
+- **Redis** for rate limiting and media processing (WhatsApp)
+- **MinIO** (S3-compatible) for file storage
+- **Traefik** as the Ingress controller
+- All core components of Typebot (builder, viewer, backend)
+
+---
+
+## 🛠️ Requirements
+
+- Helm 3.x
+- A working Kubernetes cluster (with persistent storage support)
+- A domain name with DNS configured
+- Traefik installed as your Ingress controller
+
+---
+
+## 🚀 Installation
+
+```bash
+git clone https://github.com/your-org/typebot-helm.git
+cd typebot-helm
+
+# Customize values.yaml
+vim values.yaml
+
+# Install the chart
+helm install typebot . -n typebot --create-namespace
+```
\ No newline at end of file