Merge pull request #17 from DataReply/add-component-view

add component view diagram
DataReply · Jun 1, 2023 · 63a59b3 · 63a59b3
2 parents 8fc1f09 + 26e102c
commit 63a59b3
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -21,14 +21,16 @@ realm
                 app2.yaml
 ```
 
-A reference implementation of the assumed deployment structure can be found [here](https://github.com/DataReply/korganizer-reference).
 
-Supported templating engines:
-- helmfile
-- kontemplate
+Korgi acts as glue between kubernetes templating and state management engines.
+In its current version, Korgi integrates [Helmfile](https://github.com/roboll/helmfile) and [kapp](https://github.com/vmware-tanzu/carvel-kapp) while imposing a specific deployment structure.
+
+<p align="center">
+  <img src="doc/img/korgi-component-view.png">
+</p>
+
+A reference implementation of the assumed deployment structure can be found [here](https://github.com/DataReply/korganizer-reference).
 
-Supported execution engines:
-- kapp
 
 
 # Examples

diff --git a/doc/img/korgi-component-view.png b/doc/img/korgi-component-view.png