From 08ef381a1575f3a86f02fd31f6c002bec3768845 Mon Sep 17 00:00:00 2001
From: jankovicn <nikola.jankovic@eox.at>
Date: Mon, 11 Oct 2021 14:39:35 +0200
Subject: [PATCH] updated readme and gitignore

---
 .gitignore |  2 ++
 readme.md  | 32 +++++++++++++++++++++++++++++++-
 2 files changed, 33 insertions(+), 1 deletion(-)

diff --git a/.gitignore b/.gitignore
index ba66fdd..fb61da3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,3 +5,5 @@ __pycache__/
 .mypy_cache/
 .pytest_cache/
 .pylintrc
+build/
+dist/
diff --git a/readme.md b/readme.md
index 1c00172..a21ffaf 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,33 @@
 # vs-starter
 
-Creates the docker configuration using the rendered helm templates
+Creates a docker configuration using the rendered helm templates
+
+## Install
+
+Can be installed by cloning and running
+
+```shell
+python setup.py install
+```
+
+
+## Usage
+
+The package works on rendered helm templates so the templates from helm should be
+rendered first with:
+
+```shell
+helm template <stack-name> chart --output-dir <output-dir> --values values.custom.yaml
+```
+
+Afterwards the `vs_starter` command is available:
+
+```shell
+Usage: vs_starter [OPTIONS] HELM_CONFIG_PATH OUTPUT_PATH
+
+Options:
+  -p, --param KEY=VALUE  parameters for the jinja templates [slug,
+                         service_url, release_version, sftp,
+                         shibauth_renderer, shibauth_cache]  [required]
+  --help                 Show this message and exit.
+```
-- 
GitLab