From acb44c7120d6c70063879da235f12771ce3c7b17 Mon Sep 17 00:00:00 2001
From: elliotxx <951376975@qq.com>
Date: Thu, 25 Jul 2024 16:16:06 +0800
Subject: [PATCH] refactor: bump karpor version to 0.4.3, update readme (#41)

---
 charts/karpor/Chart.yaml       |  4 ++--
 charts/karpor/README.md        | 27 +++++++++++++++++----------
 charts/karpor/README.md.gotmpl | 25 ++++++++++++++++---------
 3 files changed, 35 insertions(+), 21 deletions(-)

diff --git a/charts/karpor/Chart.yaml b/charts/karpor/Chart.yaml
index 6dbc599..f3a4c99 100644
--- a/charts/karpor/Chart.yaml
+++ b/charts/karpor/Chart.yaml
@@ -3,10 +3,10 @@
 apiVersion: v2
 name: karpor
 # The Chart Version
-version: 0.5.2
+version: 0.5.3
 type: application
 # The Application Version in the Chart
-appVersion: 0.4.2
+appVersion: 0.4.3
 description: A Helm chart for Karpor, a modern kubernetes visualization tool.
 home: https://github.com/KusionStack/karpor
 icon: https://kusionstack.io/karpor/assets/logo/logo.svg
diff --git a/charts/karpor/README.md b/charts/karpor/README.md
index 5e2f529..ce93d86 100644
--- a/charts/karpor/README.md
+++ b/charts/karpor/README.md
@@ -1,6 +1,6 @@
 # Karpor Chart
 
-![Version: 0.5.2](https://img.shields.io/badge/Version-0.5.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.4.2](https://img.shields.io/badge/AppVersion-0.4.2-informational?style=flat-square)
+![Version: 0.5.3](https://img.shields.io/badge/Version-0.5.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.4.3](https://img.shields.io/badge/AppVersion-0.4.3-informational?style=flat-square)
 
 A Helm chart for Karpor, a modern kubernetes visualization tool.
 
@@ -19,24 +19,31 @@ A Helm chart for Karpor, a modern kubernetes visualization tool.
 
 ## Prerequisites
 
-- Helm v3.5.0+
+- Helm v3+
 
 ## Installing the Chart
 
-To install the chart with the release name `my-release`:
+First, add the karpor chart repo to your local repository.
 
-```bash
-$ helm repo add kusionstack https://kusionstack.github.io/charts
-$ helm repo update
-$ helm install karpor kusionstack/karpor
+```shell
+helm repo add kusionstack https://kusionstack.github.io/charts
+helm repo update
+```
+
+Then you can use the following command to install the latest version of Karpor.
+
+```shell
+helm install karpor-release kusionstack/karpor
 ```
 
 **Note** that installing this chart directly means it will use the [default template values](./values.yaml) for Karpor.
 
-You may have to set your specific configurations if it is deployed into a production cluster, or you want to custom configure `resources`, `replicas`, `port` etc.
+You may have to set your specific configurations if it is deployed into a production cluster, or you want to customize the chart configuration, such as `resources`, `replicas`, `port` etc.
+
+All configurable parameters of the Karpor chart are detailed [here](#chart-parameters).
 
-```bash
-$ helm install my-release kusionstack/karpor --set server.replicas=3 --set syncer.port=7654
+```shell
+helm install karpor-release kusionstack/karpor --set server.replicas=3 --set syncer.port=7654
 ```
 
 ## Chart Parameters
diff --git a/charts/karpor/README.md.gotmpl b/charts/karpor/README.md.gotmpl
index 0f7e642..4e1fb0b 100644
--- a/charts/karpor/README.md.gotmpl
+++ b/charts/karpor/README.md.gotmpl
@@ -12,24 +12,31 @@
 
 ## Prerequisites
 
-- Helm v3.5.0+
+- Helm v3+
 
 ## Installing the Chart
 
-To install the chart with the release name `my-release`:
+First, add the karpor chart repo to your local repository.
 
-```bash
-$ helm repo add kusionstack https://kusionstack.github.io/charts
-$ helm repo update
-$ helm install karpor kusionstack/karpor
+```shell
+helm repo add kusionstack https://kusionstack.github.io/charts
+helm repo update
+```
+
+Then you can use the following command to install the latest version of Karpor.
+
+```shell
+helm install karpor-release kusionstack/karpor
 ```
 
 **Note** that installing this chart directly means it will use the [default template values](./values.yaml) for Karpor.
 
-You may have to set your specific configurations if it is deployed into a production cluster, or you want to custom configure `resources`, `replicas`, `port` etc.
+You may have to set your specific configurations if it is deployed into a production cluster, or you want to customize the chart configuration, such as `resources`, `replicas`, `port` etc.
+
+All configurable parameters of the Karpor chart are detailed [here](#chart-parameters).
 
-```bash
-$ helm install my-release kusionstack/karpor --set server.replicas=3 --set syncer.port=7654
+```shell
+helm install karpor-release kusionstack/karpor --set server.replicas=3 --set syncer.port=7654
 ```
 
 ## Chart Parameters