about summary refs log tree commit diff
diff options
context:
space:
mode:
authorVincent Ambo <tazjin@gmail.com>2017-02-08T12·53+0100
committerVincent Ambo <tazjin@gmail.com>2017-02-08T12·53+0100
commit6147ea7b9b4c9071ef7abe777e56f77e8497b440 (patch)
treecbc8f97eb981b66906d4985232cd479440582cfc
parent3ef0f35bfeb73adbe6b205b7bdd54ea6a49f1c97 (diff)
docs: Add usage & installation sections
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index 24bc9a37a2e5..86a0616dcc5c 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,23 @@ include:
 
 Those values are then templated into the resource files of `some-api`.
 
+## Installation
+
+Assuming you have Go configured correctly, you can simply `go get github.com/tazjin/kontemplate/...`.
+
 ## Usage
 
-You must have `kubectl` installed to use KonTemplate.
+You must have `kubectl` installed to use KonTemplate effectively.
+
+At the moment KonTemplate will simply output the templated Kubernetes resource files, which can
+then be piped into `kubectl`:
+
+```
+# Look at output and check to see if it's correct ...
+kontemplate run -f example/prod-cluster.yaml -l some-api
+
+# ... if it is, go ahead and apply it
+kontemplate run -f example/prod-cluster.yaml -l some-api | kubectl apply -f -
+
+# That's it!
+```
\ No newline at end of file