diff --git a/README.md b/README.md index e69de29bb..ccd120c6f 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,23 @@ +## Chart - Usage + +### Prerequisites +- [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 https://puzzle.github.io/cert-manager-webhook-dnsimple + ``` + If you had already added this repo earlier, run `helm repo update` to retrieve the latest versions of the packages. + + +### Installing +To install the cert-manager-webhook-dnsimple chart: +``` +helm install /cert-manager-webhook-dnsimple +``` +To uninstall the chart: +``` +helm delete +``` + +### Configuration +The required configuration values are listed in the repository's README under [puzzle/cert-manager-webhook-dnsimple](https://github.com/puzzle/cert-manager-webhook-dnsimple#options).