From 65985fa488bd70766fdcd8646cd0c2606e5bba9a Mon Sep 17 00:00:00 2001 From: Romain Pluciennik Date: Wed, 14 Aug 2024 00:44:40 +0200 Subject: [PATCH] feat(doc): Edit Chart README.md --- charts/it-tools/README.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/charts/it-tools/README.md b/charts/it-tools/README.md index 8b479b4..9c63f6a 100644 --- a/charts/it-tools/README.md +++ b/charts/it-tools/README.md @@ -11,24 +11,33 @@ it-tools is a collection of handy online tools for developers, with great UX. * -## Get repo +## Installing the Chart + +To install the chart with the release name `it-tools` + +### OCI (Recommended) + +```console +helm install it-tools oci://ghcr.io/plcnk/charts/it-tools +``` + +### Traditional ```console helm repo add plcnk https://charts.plcnk.net helm repo update +helm install it-tools plcnk/it-tools ``` -## Install chart +## Uninstalling the Chart + +To uninstall the `it-tools` deployment ```console -helm install [RELEASE_NAME] plcnk/it-tools +helm uninstall it-tools ``` -## Uninstall chart - -```console -helm uninstall [RELEASE_NAME] -``` +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. ## Parameters