From bf78cf77ad1c121c7632692769e065165ffd5bf6 Mon Sep 17 00:00:00 2001 From: Shane Sveller Date: Fri, 4 Sep 2020 17:03:43 -0500 Subject: [PATCH] Add Homebrew instructions to installation README --- install/README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/install/README.md b/install/README.md index 014d7eb9..5d31cda9 100644 --- a/install/README.md +++ b/install/README.md @@ -41,3 +41,31 @@ Run the binary: ```bash ./bin/gotk -h ``` + +## Installation via Homebrew + +MacOS users (and Linux users who choose to adopt Homebrew) may install the +`gotk` CLI via Homebrew as well. Installation instructions and prerequisites for +Homebrew are documented on that tool's [home page](https://brew.sh/). + +``` bash +brew tap fluxcd/toolkit +# Install latest tagged release +brew install fluxcd/toolkit/gotk +# Install from source +brew install --HEAD fluxcd/toolkit/gotk +``` + +Updated definitions for installing newer releases of `gotk` can be fetched once +this repository has updated the formula by executing `brew update`. The +availability of a possible upgrade can be checked using `brew outdated`. If a +newer version is available, it may be installed using `brew upgrade +fluxcd/toolkit/gotk` or prevented using `brew pin`. Please see the instructions +for more details. + +### Uninstalling via Homebrew + +``` bash +brew uninstall fluxcd/toolkit/gotk +brew untap fluxcd/toolkit +```