From dfa564acd1acce7867148a4df482592886d85162 Mon Sep 17 00:00:00 2001 From: Kimmo Lehto Date: Thu, 20 Dec 2018 09:56:04 +0200 Subject: [PATCH] Add build / installation documentation to README (#905) --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3b3365bd4..64888436c 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +Bug reports and pull requests are welcome on GitHub at https://github.com/kontena/pharos-cluster.