From 2e5ea898fe11f6c8b5e51b1c3679d75133b5414e Mon Sep 17 00:00:00 2001 From: Mojtaba Arezoomand Date: Wed, 4 Sep 2024 23:41:51 +0330 Subject: [PATCH] docs: update docs --- Chart.yaml | 4 ++-- README.md | 13 +++++++++---- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/Chart.yaml b/Chart.yaml index c27ad16..2f91dd3 100644 --- a/Chart.yaml +++ b/Chart.yaml @@ -2,5 +2,5 @@ apiVersion: v2 name: redis-cluster description: A redis-cluster helm chart type: application -version: 0.2.0 -appVersion: "0.2.0" +version: 0.4.0 +appVersion: "0.4.0" diff --git a/README.md b/README.md index 5b3107f..006943e 100644 --- a/README.md +++ b/README.md @@ -42,10 +42,15 @@ This repository contains Redis cluster helm charts that can survive pod restarts Please see the [values.yaml](https://github.com/mojixcoder/redis-cluster/blob/main/values.yaml) to see how the parameters are used. -### Deploy +### Installation -Clone the repo and `cd` to the repo directory. +You should add this package as a dependency in `Charts.yaml` file: +```yaml +dependencies: + - name: redis-cluster + version: 0.4.0 + repository: oci://registry.hub.docker.com/mojixcoder ``` -helm upgrade -i redis-cluster . -f values.yaml -``` + +To learn more about adding dependencies to your Helm charts, please follow this [link](https://helm.sh/docs/helm/helm_dependency/).