about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorVincent Ambo <tazjin@gmail.com>2017-05-18T18·54+0200
committerVincent Ambo <tazjin@gmail.com>2017-05-18T18·54+0200
commit9923b1e64d5e0a096353b06db6b132b4e4331e25 (patch)
tree1314125bcc0d9aab477dcaed9ff0f1cb857754e3 /README.md
parentde4171da318ca3b14f9aa14277c2685344a3d0a0 (diff)
docs README: Update installation instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 24 insertions, 3 deletions
diff --git a/README.md b/README.md
index 50bfae9fefd6..7b4d9ff6a5e8 100644
--- a/README.md
+++ b/README.md
@@ -72,13 +72,33 @@ to only update the `api` resource sets and the `frontend/user-page` resource set
 
 ## Installation
 
-Assuming you have Go configured correctly, you can simply `go get github.com/tazjin/kontemplate/...`.
+It is recommended to install Kontemplate from the signed binary releases available on the
+[releases page][]. Release binaries are available for Linux, OS X, FreeBSD and Windows.
+
+### Homebrew
+
+OS X users with Homebrew installed can "tap" Kontemplate like such:
 
-There are signed binary releases available on the [releases page][] for Linux, OS X,
-FreeBSD and Windows.
+```sh
+brew tap tazjin/kontemplate https://github.com/tazjin/kontemplate
+brew install kontemplate
+```
+
+### Arch Linux
 
 An [AUR package][] is available for Arch Linux and other `pacman`-based distributions.
 
+### Building repeatably from source
+
+Version pinning for Go dependencies is provided by a [Repeatr][] formula. After cloning
+the repository the latest release can be built with `repeatr run kontemplate.frm`.
+
+This will place release binaries in the `release` folder.
+
+### Building from source
+
+Assuming you have Go configured correctly, you can simply `go get github.com/tazjin/kontemplate/...`.
+
 ## Usage
 
 You must have `kubectl` installed to use Kontemplate effectively.
@@ -130,3 +150,4 @@ kontemplate apply example/prod-cluster.yaml
 [Helm]: https://helm.sh/
 [releases page]: https://github.com/tazjin/kontemplate/releases
 [AUR package]: https://aur.archlinux.org/packages/kontemplate-git/
+[Repeatr]: http://repeatr.io/