Browse Source

update docs

Alexander Belanger 5 years ago
parent
commit
e51a889bd1
2 changed files with 44 additions and 12 deletions
  1. 44 5
      README.md
  2. 0 7
      scripts/install.sh

+ 44 - 5
README.md

@@ -9,21 +9,60 @@ Porter is a **dashboard for Helm** with support for the following features:
 
 ## Quick Start
 
-To view the dashboard locally, download our CLI and grab the latest release via:
+To view the dashboard locally, follow the instructions to install the latest CLI release for [Mac](#mac-installation), [Linux](#linux-installation), or [Windows](#windows-installation). Then, run:
+
+```sh
+porter start
+```
+
+When prompted, enter the admin email/password you would like to use. After the server has started, go to `localhost:8080/login` and **log in with the credentials you just set**. 
+
+### Mac Installation
+
+Run the following command to grab the latest binary:
+
+```sh
+{
+name=$(curl -s https://api.github.com/repos/porter-dev/porter/releases/latest | grep "browser_download_url.*_Darwin_x86_64\.zip" | cut -d ":" -f 2,3 | tr -d \")
+name=$(basename $name)
+curl -L https://github.com/porter-dev/porter/releases/latest/download/$name --output $name
+unzip -a $name
+rm $name
+}
+```
+
+Then move the file into your bin:
 
 ```sh
-curl "https://api.github.com/repos/porter-dev/porter/releases/latest"
 chmod +x ./porter
 sudo mv ./porter /usr/local/bin/porter
 ```
 
-Then run the dashboard (Docker engine must be running on the host machine):
+### Linux Installation
+
+Run the following command to grab the latest binary:
 
 ```sh
-porter start
+{
+name=$(curl -s https://api.github.com/repos/porter-dev/porter/releases/latest | grep "browser_download_url.*_Linux_x86_64\.zip" | cut -d ":" -f 2,3 | tr -d \")
+name=$(basename $name)
+curl -L https://github.com/porter-dev/porter/releases/latest/download/$name --output $name
+unzip -a $name
+rm $name
+}
+```
+
+Then move the file into your bin:
+
+```sh
+chmod +x ./porter
+sudo mv ./porter /usr/local/bin/porter
 ```
 
-When prompted, enter the admin email/password you would like to use. After the server has started, go to `localhost:8080` and **log in with the credentials you just set**. 
+### Windows Installation
+
+Go [here](https://github.com/porter-dev/porter/releases/latest/download/porter_0.1.0-beta.1_Windows_x86_64.zip
+) to download the Windows executable and add the binary to your `PATH`. 
 
 ## Differences from Kubeapps
 

+ 0 - 7
scripts/install.sh

@@ -1,7 +0,0 @@
-name=(curl -s https://api.github.com/repos/jgm/pandoc/releases/latest \
-| grep "browser_download_url.*_Linux_x86_64\.tar\.gz" \
-| cut -d ":" -f 2,3 \
-| tr -d \"
-)
-
-curl -L https://github.com/porter-dev/porter/releases/latest/download/${name} --output ${name}