Changed: updated Readme (#312)

Co-authored-by: fbrintazzoli <[email protected]>
allegroai · Aug 19, 2024 · 873f222 · 873f222
1 parent fbbbee5
commit 873f222
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 7 deletions.
diff --git a/charts/clearml-agent/Chart.yaml b/charts/clearml-agent/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: clearml-agent
 description: MLOps platform Task running agent
 type: application
-version: "5.2.1"
+version: "5.2.2"
 appVersion: "1.24"
 kubeVersion: ">= 1.21.0-0 < 1.31.0-0"
 home: https://clear.ml
@@ -11,14 +11,14 @@ sources:
   - https://github.com/allegroai/clearml-helm-charts
   - https://github.com/allegroai/clearml
 maintainers:
-  - name: valeriano-manassero
-    url: https://github.com/valeriano-manassero
+  - name: filippo-clearml
+    url: https://github.com/filippo-clearml
 keywords:
   - clearml
   - "machine learning"
   - mlops
   - "task agent"
 annotations:
   artifacthub.io/changes: |
-    - kind: fixed
-      description: Create queue must be disabled by default to preserve backward compatibility
+    - kind: changed
+      description: Updated README
diff --git a/charts/clearml-agent/README.md b/charts/clearml-agent/README.md
@@ -1,6 +1,6 @@
 # ClearML Kubernetes Agent
 
-![Version: 5.2.1](https://img.shields.io/badge/Version-5.2.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.24](https://img.shields.io/badge/AppVersion-1.24-informational?style=flat-square)
+![Version: 5.2.2](https://img.shields.io/badge/Version-5.2.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.24](https://img.shields.io/badge/AppVersion-1.24-informational?style=flat-square)
 
 MLOps platform Task running agent
 
@@ -10,13 +10,21 @@ MLOps platform Task running agent
 
 | Name | Email | Url |
 | ---- | ------ | --- |
-| valeriano-manassero |  | <https://github.com/valeriano-manassero> |
+| filippo-clearml |  | <https://github.com/filippo-clearml> |
 
 ## Introduction
 
 The **clearml-agent** is the Kubernetes agent for for [ClearML](https://github.com/allegroai/clearml).
 It allows you to schedule distributed experiments on a Kubernetes cluster.
 
+## Add to local Helm repository
+
+To add this chart to your local Helm repository:
+
+```
+helm repo add allegroai https://allegroai.github.io/clearml-helm-charts
+```
+
 # Upgrading Chart
 
 ## Upgrades/ Values upgrades

diff --git a/charts/clearml-agent/README.md.gotmpl b/charts/clearml-agent/README.md.gotmpl
@@ -14,6 +14,14 @@
 The **clearml-agent** is the Kubernetes agent for for [ClearML](https://github.com/allegroai/clearml).
 It allows you to schedule distributed experiments on a Kubernetes cluster.
 
+## Add to local Helm repository
+
+To add this chart to your local Helm repository:
+
+```
+helm repo add allegroai https://allegroai.github.io/clearml-helm-charts
+```
+
 # Upgrading Chart
 
 ## Upgrades/ Values upgrades