From 34b10a7b0531d987db243f79175544de67041d09 Mon Sep 17 00:00:00 2001 From: Giovanni Gargiulo Date: Fri, 8 Mar 2024 12:06:15 +0000 Subject: [PATCH] chore: Additional info about usage and build in README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 84d1345..fb8c91f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,27 @@ This repository contains Helm Charts commonly used and developed at the Cardano Use at your own risk. +## Usage + +[Helm](https://helm.sh) must be installed to use the charts. Please refer to +Helm's [documentation](https://helm.sh/docs) to get started. + +Once Helm has been set up correctly, add the repo as follows: + +`helm repo add cf-helm https://cardano-foundation.github.io/cf-helm-charts` + +If you had already added this repo earlier, run `helm repo update` to retrieve +the latest versions of the packages. You can then run `helm search repo +cf-helm` to see the charts. + +To install the chart: + + helm install my- cf-helm/ + +To uninstall the chart: + + helm delete my- + ## Helm Chart Build This repo is configured following the Helm Chart docs available [here](https://helm.sh/docs/topics/chart_repository/) @@ -28,3 +49,7 @@ helm repo index charts --url https://cardano-foundation.github.io/cf-helm-charts Add new or modified files to git, push changes. Congrats, you've deployed a new or updated chart to our repository + +### Automated Release + +This repo has been configured to automatically release new and updated charts following [this gha](https://helm.sh/docs/howto/chart_releaser_action/)