Skip to content

Commit

Permalink
chore: Additional info about usage and build in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nemo83 committed Mar 8, 2024
1 parent c27ab18 commit 34b10a7
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-name> chart:

helm install my-<chart-name> cf-helm/<chart-name>

To uninstall the chart:

helm delete my-<chart-name>

## Helm Chart Build

This repo is configured following the Helm Chart docs available [here](https://helm.sh/docs/topics/chart_repository/)
Expand All @@ -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/)

0 comments on commit 34b10a7

Please sign in to comment.