Skip to content

Commit

Permalink
Add build / installation documentation to README (#905)
Browse files Browse the repository at this point in the history
  • Loading branch information
kke authored and jakolehm committed Dec 20, 2018
1 parent 4184803 commit dfa564a
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,39 @@

Pharos Cluster is a [Kontena Pharos](https://pharos.sh) (Kubernetes distribution) management tool. It handles cluster bootstrapping, upgrades and other maintenance tasks via SSH connection and Kubernetes API access.

## Installation

### chpharos
The easiest way to install is to use the Kontena Pharos version switcher [chpharos](https://github.com/kontena/pharos-cluster).

```
$ chpharos install latest
$ pharos --help
```

### Download binaries

The binary packages are available on the Downloads section of your [Kontena Account](https://account.kontena.io/) page.

### Build and install Ruby gem

You need Ruby version 2.5

```
$ gem build pharos-cluster.gemspec
$ gem install pharos-cluster*.gem
$ pharos --help
```

## Usage

See [documentation](https://pharos.sh/docs/).

## Further Information

- [Documentation](https://pharos.sh/docs/)
- [Slack](https://slack.kontena.io)
- [Website](https://pharos.sh/)

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kontena/pharos-cluster.
Bug reports and pull requests are welcome on GitHub at https://github.com/kontena/pharos-cluster.

0 comments on commit dfa564a

Please sign in to comment.