Added template overrides for readme

DreamingRaven · Oct 3, 2024 · 1944b48 · 1944b48
1 parent 0666c55
commit 1944b48
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 1 deletion.
diff --git a/charts/corvid-test/README.md b/charts/corvid-test/README.md
@@ -1,8 +1,18 @@
 # corvid-test
 
+A Helm chart for Kubernetes
+
 ![Version: 0.6.0](https://img.shields.io/badge/Version-0.6.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)
 
-A Helm chart for Kubernetes
+## Installing the Chart
+
+To install the chart with the release name `corvid-test`, run the following commands:
+
+```console
+$ helm repo add raven https://gitlab.com/api/v4/projects/55284972/packages/helm/stable
+$ helm repo update raven
+$ helm install corvid-test raven/corvid-test
+```
 
 ## Requirements
 

diff --git a/charts/corvid-test/README.md.gotmpl b/charts/corvid-test/README.md.gotmpl
@@ -0,0 +1,20 @@
+{{ template "chart.header" . }}
+{{ template "chart.description" . }}
+
+{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
+
+## Installing the Chart
+
+To install the chart with the release name `{{ template "chart.name" . }}`, run the following commands:
+
+```console
+$ helm repo add raven https://gitlab.com/api/v4/projects/55284972/packages/helm/stable
+$ helm repo update raven
+$ helm install {{ template "chart.name" . }} raven/{{ template "chart.name" . }}
+```
+
+{{ template "chart.requirementsSection" . }}
+
+{{ template "chart.valuesSection" . }}
+
+{{ template "helm-docs.versionFooter" . }}