Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Fouad committed Nov 15, 2020
1 parent 937ce86 commit 73d14b6
Showing 1 changed file with 5 additions and 16 deletions.
21 changes: 5 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,26 +31,15 @@ Please make sure the following are installed prior to using `Robban` as a binary
If you use private helm repos, you will need either `helm-gcs` or `helm-s3` plugin or you can use basic auth to authenticate to your repos. See the [docs](https://github.com/Praqma/helmsman/blob/master/docs/how_to/helm_repos) for details.


Check the [releases page](https://github.com/Praqma/Helmsman/releases) for the different versions.
```
# on Linux
curl -L https://github.com/Praqma/helmsman/releases/download/v3.4.2/helmsman_3.4.2_linux_amd64.tar.gz | tar zx
# on MacOS
curl -L https://github.com/Praqma/helmsman/releases/download/v3.4.2/helmsman_3.4.2_darwin_amd64.tar.gz | tar zx
mv helmsman /usr/local/bin/helmsman
```

## As a docker image
Check the images on [dockerhub](https://hub.docker.com/r/praqma/helmsman/tags/)
Check the images on [dockerhub](https://hub.docker.com/r/tactful/robban)

## As a package
Helmsman has been packaged in Archlinux under `helmsman-bin` for the latest binary release, and `helmsman-git` for master.
```bash
docker pull tactful/robban
```

# Documentation

> Documentation for Helmsman v1.x can be found at: https://github.com/Praqma/helmsman/tree/1.x/docs
- [How-Tos](https://github.com/Praqma/helmsman/blob/master/docs/how_to/).

- [Desired state specification](https://github.com/Praqma/helmsman/blob/master/docs/desired_state_specification.md).
Expand All @@ -60,7 +49,7 @@ Helmsman has been packaged in Archlinux under `helmsman-bin` for the latest bina

## Usage

Helmsman can be used in three different settings:
Robban can be used in three different settings:

- [As a binary with a hosted cluster](https://github.com/Praqma/helmsman/blob/master/docs/how_to/settings).
- [As a docker image in a CI system or local machine](https://github.com/Praqma/helmsman/blob/master/docs/how_to/deployments/ci.md) Always use a tagged docker image from [dockerhub](https://hub.docker.com/r/praqma/helmsman/) as the `latest` image can (at times) be unstable.
Expand Down

0 comments on commit 73d14b6

Please sign in to comment.