Update with installation instructions
@@ -4,18 +4,58 @@ Kubernetes dashboard for developers
## Running
+Start the developer dashboard:
+
`$ hcli dash`
-## Developing
+Check the version:
+
+`$ hcli version`
### Prerequisites
* Go 1.11
-* npm
+* npm 6.4.1 or higher
* yarn
* [rice CLI](https://github.com/GeertJohan/go.rice)
* Install with `go get github.com/GeertJohan/go.rice/rice`
+## Install
+
+### Download a prebuilt binary
+
+Go to the [releases page](https://github.com/heptio/developer-dash/releases) and download the tarball.
+
+Extract the tarball:
+
+```
+$ tar -xzvf ~/Downloads/hcli_0.1.1_Linux-64bit.tar.gz
+hcli_0.1.1_Linux-64bit/README.md
+hcli_0.1.1_Linux-64bit/hcli
+```
+
+Verify it runs:
+
+`$ ./hcli_0.1.1_Linux-64bit/hcli version`
+
+Decide to move the binary in `/usr/local/bin` or your home directory. Installing to `/usr/local/bin` is for system-wide installation but makes running multiple versions difficult. If the dashboard is installed to your home directory, make sure to update your `$PATH` variable then check `which hcli` to verify installation is successful.
+
+### Manually build and install
+
+This option is for users who want to build from master. Make sure the prerequisites listed above are installed.
+
+`$ go get github.com/heptio/developer-dashboard`
+
+Package the web assets to be built into the binary.
+
+`$ make web-build`
+
+There should be a new directory: `$GOPATH/src/github.com/heptio/developer-dash/web/build`. Finally, build the binary:
+
+`$ make hcli-dev`
+
+The `hcli` binary will be found in `$GOPATH/src/github.com/heptio/developer-dash/build`.
+
### Environment variables
* `KUBECONFIG` - set to non-empty location if you want to set KUBECONFIG with an environment variable.
@@ -32,11 +72,15 @@ Kubernetes dashboard for developers
`$ make setup-web`
-### Building binary with embedded web assets
+### Running development server
+
+The development server allows running the dashboard while monitoring changes in `/web`.
+
+Start the dashboard running on a development server:
-1) Run `$ make web-build` to rebuild web assets
+`$ make -u ui-client ui-server`
-2) Create `./build/hcli`: `$ make hcli-dev`
+Navigate to `localhost:7777` on a browser to view cluster data.
### Caveats
