From ed490bad59d5c9d562aa6920f85a911e1c0e2dc1 Mon Sep 17 00:00:00 2001 From: Charlie Moog Date: Thu, 24 Dec 2020 22:54:38 -0600 Subject: [PATCH 1/3] docs: add brew install snippet to readme --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 93b78902..587ed732 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# coder-cli +# Coder CLI [![GitHub Release](https://img.shields.io/github/v/release/cdr/coder-cli?color=6b9ded&include_prerelease=false)](https://github.com/cdr/coder-cli/releases) [![Documentation](https://godoc.org/cdr.dev/coder-cli?status.svg)](https://pkg.go.dev/cdr.dev/coder-cli/coder-sdk) @@ -9,20 +9,23 @@ To report bugs and request features, please [open an issue](https://github.com/cdr/coder-cli/issues/new). -## Usage +## Installation -View the `coder-cli` documentation [here](./docs/coder.md). +### macOS -You can find additional Coder Enterprise usage documentation on [https://enterprise.coder.com](https://enterprise.coder.com/docs/getting-started). +```text +brew install cdr/coder/coder +``` -## Install Release +### Windows / Linux Download the latest [release](https://github.com/cdr/coder-cli/releases): 1. Click a release and download the tar file for your operating system (ex: coder-cli-linux-amd64.tar.gz) -2. Extract the `coder` binary from the tar file, ex: +2. Extract the `coder` binary. -```bash -cd ~/go/bin -tar -xvf ~/Downloads/coder-cli-linux-amd64.tar.gz -``` +## Usage + +View the usage documentation [here](./docs/coder.md). + +You can find additional Coder usage documentation on [coder.com/docs/cli](https://coder.com/docs/cli). From 268ee2c1c5a5324baa34cacb8a69e3485b3ba57e Mon Sep 17 00:00:00 2001 From: Charlie Moog Date: Fri, 25 Dec 2020 10:01:46 -0600 Subject: [PATCH 2/3] fixup! docs: add brew install snippet to readme --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 587ed732..3d177563 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,13 @@ To report bugs and request features, please [open an issue](https://github.com/c ## Installation -### macOS +### Homebrew (Mac, Linux) -```text +```sh brew install cdr/coder/coder ``` -### Windows / Linux +### Download (Windows, Linux, Mac) Download the latest [release](https://github.com/cdr/coder-cli/releases): From 8882320a2b88d4332d346b11cfd0a66ed299e2dd Mon Sep 17 00:00:00 2001 From: Charlie Moog Date: Fri, 25 Dec 2020 12:33:21 -0600 Subject: [PATCH 3/3] fixup! docs: add brew install snippet to readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3d177563..11e09fa5 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ To report bugs and request features, please [open an issue](https://github.com/c ### Homebrew (Mac, Linux) ```sh -brew install cdr/coder/coder +brew install cdr/coder/coder-cli ``` ### Download (Windows, Linux, Mac)