Skip to content
This repository was archived by the owner on Aug 30, 2024. It is now read-only.

Commit 84f8540

Browse files
authored
docs: add homebrew install snippet to readme (#208)
1 parent 7fcfe98 commit 84f8540

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

+13-10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# coder-cli
1+
# Coder CLI
22

33
[![GitHub Release](https://img.shields.io/github/v/release/cdr/coder-cli?color=6b9ded&include_prerelease=false)](https://github.com/cdr/coder-cli/releases)
44
[![Documentation](https://godoc.org/cdr.dev/coder-cli?status.svg)](https://pkg.go.dev/cdr.dev/coder-cli/coder-sdk)
@@ -9,20 +9,23 @@
99

1010
To report bugs and request features, please [open an issue](https://github.com/cdr/coder-cli/issues/new).
1111

12-
## Usage
12+
## Installation
1313

14-
View the `coder-cli` documentation [here](./docs/coder.md).
14+
### Homebrew (Mac, Linux)
1515

16-
You can find additional Coder Enterprise usage documentation on [https://enterprise.coder.com](https://enterprise.coder.com/docs/getting-started).
16+
```sh
17+
brew install cdr/coder/coder-cli
18+
```
1719

18-
## Install Release
20+
### Download (Windows, Linux, Mac)
1921

2022
Download the latest [release](https://github.com/cdr/coder-cli/releases):
2123

2224
1. Click a release and download the tar file for your operating system (ex: coder-cli-linux-amd64.tar.gz)
23-
2. Extract the `coder` binary from the tar file, ex:
25+
2. Extract the `coder` binary.
2426

25-
```bash
26-
cd ~/go/bin
27-
tar -xvf ~/Downloads/coder-cli-linux-amd64.tar.gz
28-
```
27+
## Usage
28+
29+
View the usage documentation [here](./docs/coder.md).
30+
31+
You can find additional Coder usage documentation on [coder.com/docs/cli](https://coder.com/docs/cli).

0 commit comments

Comments
 (0)