From 316373719c99710f8f5dd1d1413f4c75a0e9d94a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Charles-Edouard=20Br=C3=A9t=C3=A9ch=C3=A9?= Date: Mon, 9 Oct 2023 11:52:23 +0200 Subject: [PATCH] chore: add install docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Charles-Edouard Brétéché --- website/docs/install.md | 42 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/website/docs/install.md b/website/docs/install.md index 3594e09d..28b06197 100644 --- a/website/docs/install.md +++ b/website/docs/install.md @@ -1,3 +1,43 @@ # Install -TODO +You can install the pre-compiled binary (in several ways), or compile from source. + +## Install using `go install` + +You can install with `go install` with: + +```bash +go install github.com/kyverno/kyverno-json@latest +``` + +## Manually + +``` +Download the pre-compiled binaries from the [releases page](https://github.com/kyverno/kyverno-json/releases) and copy them to the desired location. +``` + +## Compile from sources + +**clone:** + +```bash +git clone github.com/kyverno/kyverno-json +``` + +**get the dependencies:** + +```bash +go mod tidy +``` + +**build:** + +```bash +make build +``` + +**verify it works:** + +```bash +./kyverno-json version +``` \ No newline at end of file