Merge pull request #9 from devopshobbies/docs/update

docs(README.md): updated readme and added banner
devopshobbies · Jul 21, 2023 · fa114df · fa114df
2 parents 1b8cb9a + 3ce2047
commit fa114df
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/.github/assets/helm-generic-chart.png b/.github/assets/helm-generic-chart.png
diff --git a/README.md b/README.md
@@ -1,9 +1,12 @@
-# One chart to rule them all.
+# Devopshobbies helm generic chart
 
-This was one funny note I found. It is describing the goal of what is a generic helm chart in a fun manner.
+![DevopsHobbies helm generic chart](.github/assets/helm-generic-chart.png)
+This chart is created to be used inside devopshobbies & kaiser-io devops operations.
 
-## how to use this:
+## How it works:
 
-```
-# Needs to be completed.
-```
+The use-case is pretty simple and you can start using this by fetching the chart. Also, there is one `values`.example.yaml` defined for you which you can check and have a look at to find out how to set the variables.
+
+## How release and versioning work:
+
+The versioning and releasing logic is so fairly simple, just push a commit on main branch and you have it.