diff --git a/README.md b/README.md index 47827e3e..d68558e5 100644 --- a/README.md +++ b/README.md @@ -63,18 +63,18 @@ Similarly, if you change `enabled` back to `true`, it will figure out that you w Helmsman can be used in two ways: -1. In a continuous deployment pipeline. In this case Helmsman can be used in a docker container run by your CI system to maintain your desired state (which you can store in a version control repository). The docker image can be used as: +1. In a continuous deployment pipeline. In this case Helmsman can be used in a docker container run by your CI system to maintain your desired state (which you can store in a version control repository). The docker image will be available soon. -``` -docker run -it praqma/helmsman +[comment]: <>(```docker run -it praqma/helmsman ```) -``` -The docker image is built from a [dockerfile](dockerfile/dockerfile). +[comment]: <>(The docker image is built from a [dockerfile](dockerfile/dockerfile).) 2. As a binary application. Helmsman dependes on [Helm](https://helm.sh) and [Kubectl](https://kubernetes.io/docs/user-guide/kubectl/) being installed. See below for installation. # Installation +Install Helmsman for your OS from the [releases page](https://github.com/Praqma/Helmsman/releases). Currently, available for both Linux and MacOS only. + # Documentaion Documentation can be found under the [docs](/docs/) directory.