From 209c0027c5533e356b53efe7e602cbe041d2565d Mon Sep 17 00:00:00 2001
From: Kirill Sibirev <l0kix2@gmail.com>
Date: Tue, 11 Jun 2024 12:31:44 +0200
Subject: [PATCH] Update README.md

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 1cb1fff..f9db635 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,18 @@
 # ytsaurus-identity-sync
 
+## Installing
+To install application to your k8s cluster — use helm chart with something like that:
+```
+helm upgrade --install --wait \
+ -f ytsaurus-identity-sync.values.yaml \
+ -n idsync --create-namespace \
+ idsync oci://ghcr.io/tractoai/ytsaurus-identity-sync-chart \
+--version 0.2.0
+```
+Examples for helm values can be found in the [examples](examples) directory.  
+All configuration options for app can be found in [main/config.go](main/config.go) file.
+
+
 ## Official release
 To issue an official release of app — create new release at the [releases](https://github.com/tractoai/ytsaurus-identity-sync/releases) tab with some release notes.  
 For the app release create a tag matching pattern `release/X.X.X`.