From c6500e7b4ec16cfdd0a522ddc1b77763d34d19a5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andr=C3=A9=20Bauer?= <andre.bauer@staffbase.com>
Date: Wed, 20 Jul 2022 12:22:31 +0200
Subject: [PATCH] added vrt readme
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: André Bauer <andre.bauer@staffbase.com>
---
 charts/visual-regression-tracker/Chart.yaml |  5 ++-
 charts/visual-regression-tracker/README.md  | 50 +++++++++++++++++++++
 2 files changed, 53 insertions(+), 2 deletions(-)
 create mode 100644 charts/visual-regression-tracker/README.md

diff --git a/charts/visual-regression-tracker/Chart.yaml b/charts/visual-regression-tracker/Chart.yaml
index 592c12f..3efcf4c 100644
--- a/charts/visual-regression-tracker/Chart.yaml
+++ b/charts/visual-regression-tracker/Chart.yaml
@@ -1,11 +1,12 @@
 apiVersion: v2
 name: visual-regression-tracker
-description: A Helm chart for Visual Regression Tracker
+description: Backend and Frontend application for tracking differences via image comparison
 home: https://visual-regression-tracker.com
 sources:
   - https://github.com/Visual-Regression-Tracker/Visual-Regression-Tracker
+  - https://github.com/kokuwaio/helm-charts/tree/main/charts/visual-regression-tracker
 type: application
-version: 0.3.0
+version: 0.3.1
 appVersion: "4.20.4"
 maintainers:
   - name: monotek
diff --git a/charts/visual-regression-tracker/README.md b/charts/visual-regression-tracker/README.md
new file mode 100644
index 0000000..65fdb79
--- /dev/null
+++ b/charts/visual-regression-tracker/README.md
@@ -0,0 +1,50 @@
+# Visual Regression Tracker
+
+Visual Regression Tracker is a backend and frontend application for tracking differences via image comparison. This Helm chart installs a Kubernetes statefulset containing the UI and API components.
+
+If you want to run this chart with more than 1 replica, get sure you can use a [ReadWriteMany PVC](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes), as the pods needs to share the imageUploads volume.
+
+## Add Helm Repository
+
+```console
+helm repo add kokuwa https://kokuwaio.github.io/helm-charts
+helm repo update
+```
+
+_See [`helm repo`](https://helm.sh/docs/helm/helm_repo/) for command documentation._
+
+## Install Chart
+
+```console
+helm install vrt kokuwa/visual-regression-tracker
+```
+
+_See [configuration](#configuration) below._
+
+_See [`helm install`](https://helm.sh/docs/helm/helm_install/) for command documentation._
+
+## Configuration
+
+See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands:
+
+```console
+helm show values kokuwa/visual-regression-tracker
+```
+
+## Uninstall Chart
+
+```console
+helm uninstall vrt
+```
+
+This removes all the Kubernetes components associated with the chart and deletes the release.
+
+_See [`helm uninstall`](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._
+
+## Upgrading the Helm Chart
+
+```console
+helm upgrade vrt kokuwa/visual-regression-tracker
+```
+
+_See [`helm upgrade`](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._