diff --git a/README.md b/README.md index 7e1cb62..650a1aa 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,26 @@ [![lint](https://github.com/kudobuilder/kuttl/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/kudobuilder/kuttl/actions) [![unit test](https://github.com/kudobuilder/kuttl/actions/workflows/unittest.yml/badge.svg?branch=main)](https://github.com/kudobuilder/kuttl/actions) [![integration-test](https://github.com/kudobuilder/kuttl/actions/workflows/integration-test.yml/badge.svg?branch=main)](https://github.com/kudobuilder/kuttl/actions) -[![Go Report Card](https://goreportcard.com/badge/github.com/kudobuilder/kuttl)](https://goreportcard.com/report/github.com/kudobuilder/kuttl) +[![Go Report Card](https://goreportcard.com/badge/github.com/kudobuilder/kuttl)](https://goreportcard.com/report/github.com/kudobuilder/kuttl) KUbernetes Test TooL (KUTTL) provides a declarative approach to test Kubernetes Operators. KUTTL is designed for testing operators, however it can declaratively test any kubernetes objects. +## Installation + +To install our custom fork of KUTTL, you can either pull the pre-compiled from Nexus: +``` +curl -Lo kuttl "https://repo.stackable.tech/repository/packages/kuttl/stable-{$(arch)}" +sudo mv kuttl /usr/local/bin +sudo chmod +x /usr/local/bin/kuttl +``` + +Or install it from source: +``` +go install github.com/stackabletech/kuttl/cmd/kubectl-kuttl@latest +``` + ## Getting Started Please refer to the [getting started guide](docs/README.md) documentation.