From 90b617f1946991335d64489412628530547ecdb5 Mon Sep 17 00:00:00 2001
From: Maor Friedman <maor.friedman@nuvo-group.com>
Date: Sun, 16 Sep 2018 13:16:30 +0300
Subject: [PATCH] Update readme

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

diff --git a/README.md b/README.md
index 2f475d6..2c53ddd 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,20 @@ glide up -v
 go build -o orca cmd/orca.go
 ```
 
+## Commands
+
+The following commands are available:
+```
+delete env              Delete an environment (Kubernetes namespace) along with all Helm releases in it
+delete resource         Delete a resource from REST API
+deploy chart            Deploy a Helm chart from chart repository
+deploy env              Deploy a list of Helm charts to an environment (Kubernetes namespace)
+determine buildtype     Determine build type based on path filters
+get env                 Get list of Helm releases in an environment (Kubernetes namespace)
+get resource            Get a resource from REST API
+push chart              Push Helm chart to chart repository
+```
+
 ## Examples
 
 ### Build type determination
@@ -32,6 +46,18 @@ orca determine buildtype \
     --prev-commit <previousCommitHash>
 ```
 
+In this example, if the current reference is different from the mainline and a release branch, the build type will be set to `default`:
+```
+orca determine buildtype \
+    --default-type default \
+    --curr-ref develop \
+    --main-ref master \
+    --rel-ref ^.*/rel-.*$
+```
+
+The two examples can be combined.
+
+
 ### Get resource
 This function gets a resource from REST API.
 
@@ -40,12 +66,27 @@ In this example, it gets the previous commit hash (offset of 1 from the current
 ```
 orca get resource \
     --url <pipelinesURL> \
+    --headers "<header>:<value>" \
     --key sha \
     --value <currentCommit> \
     --offset 1 \
     --print-key sha
 ```
 
+### Get env
+This functions gets all Helm installed releases from an environment (Kubernetes namespace).
+
+In this example, only orca managed releases will be displayed (a managed release is considered one with release name in the form of namespace-chartName):
+
+```
+orca get env \
+    --kube-context <kubeContext> \
+    --name <namespace>
+```
+
+You can add the `--only-managed=false` to show all releases in a namespace.
+
+
 ### Deploy chart
 This function deploys a Helm chart from a chart repository, using values files which are packed along with the chart.