docs(helm): add helm install instructions

karlderkaefer · Nov 18, 2022 · c2a738e · c2a738e
1 parent 9a25b34
commit c2a738e
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 4 deletions.
diff --git a/charts/argocd-ecr-updater/Chart.yaml b/charts/argocd-ecr-updater/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: argocd-ecr-updater
 description: A Helm chart to update the ECR token for ECR based helm repositories
 type: application
-version: 0.3.3
+version: 0.3.4
 appVersion: "1.1.6"
 sources:
   - https://github.com/karlderkaefer/argocd-ecr-update

diff --git a/charts/argocd-ecr-updater/README.md b/charts/argocd-ecr-updater/README.md
@@ -2,7 +2,7 @@
 
 A Helm chart to update the ECR token for ECR based helm repositories
 
-![Version: 0.3.3](https://img.shields.io/badge/Version-0.3.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.6](https://img.shields.io/badge/AppVersion-1.1.6-informational?style=flat-square)
+![Version: 0.3.4](https://img.shields.io/badge/Version-0.3.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.6](https://img.shields.io/badge/AppVersion-1.1.6-informational?style=flat-square)
 
 ## Maintainers
 
@@ -14,7 +14,20 @@ A Helm chart to update the ECR token for ECR based helm repositories
 
 * <https://github.com/karlderkaefer/argocd-ecr-update>
 
-## ## Values
+## Get Helm Repository Info
+
+```
+helm repo add argocd-ecr-updater https://karlderkaefer.github.io/argocd-ecr-updater
+helm search repo argocd-ecr-updater
+```
+
+## Install Helm Chart
+
+```
+helm upgrade --install argocd-ecr-updater -n argocd argocd-ecr-updater/argocd-ecr-updater
+```
+
+## Values
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|

diff --git a/charts/argocd-ecr-updater/README.md.gotmpl b/charts/argocd-ecr-updater/README.md.gotmpl
@@ -11,7 +11,20 @@
 
 {{ template "chart.sourcesList" . }}
 
-## {{ template "chart.valuesHeader" . }}
+## Get Helm Repository Info
+
+```
+helm repo add argocd-ecr-updater https://karlderkaefer.github.io/argocd-ecr-updater
+helm search repo argocd-ecr-updater
+```
+
+## Install Helm Chart
+
+```
+helm upgrade --install argocd-ecr-updater -n argocd argocd-ecr-updater/argocd-ecr-updater
+```
+
+{{ template "chart.valuesHeader" . }}
 
 {{ template "chart.valuesTable" . }}