diff --git a/Makefile b/Makefile index 3c9ad52a..2ba9e006 100644 --- a/Makefile +++ b/Makefile @@ -22,7 +22,7 @@ install: build cp plugin.yaml $(HELM_HOME)/plugins/helm-diff/ .PHONY: install/helm3 -install/helm3: +install/helm3: build mkdir -p $(HELM_3_PLUGINS)/helm-diff/bin cp bin/diff $(HELM_3_PLUGINS)/helm-diff/bin cp plugin.yaml $(HELM_3_PLUGINS)/helm-diff/ diff --git a/README.md b/README.md index 79cb39fb..e941a3d7 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,27 @@ E.g. curl -L $TARBALL_URL | tar -C $(helm home)/plugins -xzv ``` +### From Source +#### Prerequisites + - GoLang `>= 1.14` + +Make sure you do not have a verison of `helm-diff` installed. You can remove it by running `helm plugin uninstall diff` + +#### Installation Steps +The first step is to download the repository and enter the directory. You can do this via `git clone` or downloaing and extracting the release. If you clone via git, remember to checkout the latest tag for the latest release. + +Next, depending on which helm version you have, install the plugin into helm. + +##### Helm 2 +```bash +make install +``` + +##### Helm 3 +```bash +make install/helm3 +``` + ## Usage