From 6147ea7b9b4c9071ef7abe777e56f77e8497b440 Mon Sep 17 00:00:00 2001
From: Vincent Ambo <tazjin@gmail.com>
Date: Wed, 8 Feb 2017 13:53:46 +0100
Subject: docs: Add usage & installation sections

---
 README.md | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

(limited to 'README.md')

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
-- 
cgit 1.4.1