Skip to content

Commit e3226e1

Browse files
authored
simplify readme to point to render docs site (#162)
1 parent 27bb8ec commit e3226e1

1 file changed

Lines changed: 4 additions & 32 deletions

File tree

README.md

Lines changed: 4 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,10 @@
11
# Render CLI
22

3-
# Getting Started
4-
53
## Installation
64

7-
### Homebrew (Recommended for MacOS)
8-
9-
You can install the Render CLI using Homebrew by running the following commands:
10-
11-
```sh
12-
brew tap render-oss/homebrew-render
13-
brew update
14-
brew install render
15-
```
16-
17-
### Building from source
18-
19-
To build the Render CLI from source, you will need to have Go installed on your machine. You can install Go by following the [Go installation instructions](https://golang.org/doc/install).
20-
21-
Once you have Go installed, you can build the Render CLI by running the following commands:
22-
23-
```sh
24-
git clone git@github.com:render-oss/cli.git
25-
cd cli
26-
go build -o render
27-
```
28-
29-
This will create a binary called `render` in the current directory. You can move this binary to a directory in your `PATH` to make it easier to use.
30-
31-
### Downloading a pre-built binary
32-
33-
Pre-built binaries for the Render CLI are available on the [Releases page](https://github.com/render-oss/cli/releases/) of this repository. You can download the binary for your platform and move it to a directory in your `PATH` to make it easier to use.
34-
35-
## Configuration
5+
- [Homebrew](https://render.com/docs/cli#homebrew-macos-linux)
6+
- [Direct Download](https://render.com/docs/cli#direct-download)
367

37-
The CLI expects an API key to be set in the `RENDER_API_KEY` environment variable. You can generate an API key from your [user settings page](https://dashboard.render.com/u/settings#api-keys).
8+
## Documentation
389

10+
Documentation is hosted at https://render.com/docs/cli

0 commit comments

Comments
 (0)