feat: update README for OCI instructions (#418)

Signed-off-by: Engin Diri <[email protected]> Signed-off-by: Engin Diri <[email protected]>
dirien · Nov 24, 2022 · 0544744 · 0544744
1 parent 1d16aa8
commit 0544744
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 5 deletions.
diff --git a/charts/minecraft-exporter/Chart.yaml b/charts/minecraft-exporter/Chart.yaml
@@ -7,7 +7,7 @@ keywords:
   - prometheus
   - exporter
 type: application
-version: 0.10.2
+version: 0.10.3
 appVersion: 0.17.1
 home: https://github.com/dirien/minecraft-prometheus-exporter/
 sources:
@@ -19,7 +19,7 @@ maintainers:
 annotations:
   artifacthub.io/containsSecurityUpdates: "false"
   artifacthub.io/changes: |
-    - support oci chart repository
+    - update README for OCI instructions
   artifacthub.io/images: |
     - name: minecraft-exporter
       image: ghcr.io/dirien/minecraft-exporter

diff --git a/charts/minecraft-exporter/README.md b/charts/minecraft-exporter/README.md
@@ -2,7 +2,7 @@
 
 ![minecraft-exporter](https://dirien.github.io/minecraft-prometheus-exporter/img/minecraft-exporter.jpg)
 
-![Version: 0.10.2](https://img.shields.io/badge/Version-0.10.2-informational?style=for-the-badge) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=for-the-badge) ![AppVersion: 0.17.1](https://img.shields.io/badge/AppVersion-0.17.1-informational?style=for-the-badge)
+![Version: 0.10.3](https://img.shields.io/badge/Version-0.10.3-informational?style=for-the-badge) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=for-the-badge) ![AppVersion: 0.17.1](https://img.shields.io/badge/AppVersion-0.17.1-informational?style=for-the-badge)
 
 ![Prometheus](https://img.shields.io/badge/Prometheus-E6522C?style=for-the-badge&logo=Prometheus&logoColor=white)
 ![Minecraft](https://img.shields.io/badge/Minecraft-62B47A?style=for-the-badge&logo=Minecraft&logoColor=white)
@@ -16,6 +16,16 @@
 
 A Helm chart for prometheus minecraft exporter
 
+## Usage (via OCI Registry)
+
+To install the chart using the OCI artifact, run:
+
+```bash
+helm install minecraft-exporter oci://ghcr.io/dirien/charts/minecraft-exporter --version 0.10.3
+```
+
+Keep in mind that you need Helm > 3.8.0 to use the [OCI feature](https://helm.sh/blog/storing-charts-in-oci/).
+
 ## Usage
 
 Please add the minecraft-exporter repository before installing any chart provided by this repository:
@@ -30,7 +40,7 @@ helm repo update
 To install the chart with the release name minecraft-exporter run:
 
 ```bash
-helm install minecraft-exporter minecraft-exporter/minecraft-exporter --version 0.10.2
+helm install minecraft-exporter minecraft-exporter/minecraft-exporter --version 0.10.3
 ```
 
 After a few seconds, minecraft-exporter should be running.
@@ -39,7 +49,7 @@ To install the chart in a specific namespace use following commands:
 
 ```bash
 kubectl create ns minecraft-exporter
-helm install minecraft-exporter minecraft-exporter/minecraft-exporter --namespace minecraft-exporter --version 0.10.2
+helm install minecraft-exporter minecraft-exporter/minecraft-exporter --namespace minecraft-exporter --version 0.10.3
 ```
 
 > **Tip**: List all releases using `helm list`, a release is a name used to track a specific deployment

diff --git a/charts/minecraft-exporter/README.md.gotmpl b/charts/minecraft-exporter/README.md.gotmpl
@@ -16,6 +16,16 @@
 
 {{ template "chart.description" . }}
 
+## Usage (via OCI Registry)
+
+To install the chart using the OCI artifact, run:
+
+```bash
+helm install minecraft-exporter oci://ghcr.io/dirien/charts/minecraft-exporter --version {{ .Version }}
+```
+
+Keep in mind that you need Helm > 3.8.0 to use the [OCI feature](https://helm.sh/blog/storing-charts-in-oci/).
+
 ## Usage
 
 Please add the minecraft-exporter repository before installing any chart provided by this repository: