From 35cd7bad8c77747e7860b78546b19fc9ca77152c Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Thu, 16 Jun 2022 16:24:59 -0500 Subject: [PATCH] chore: sync readme and install --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8a3ef717c64ef..6b5282378265d 100644 --- a/README.md +++ b/README.md @@ -33,20 +33,28 @@ Coder creates remote development machines so your team can develop from anywhere > **Note**: > Coder is in an alpha state. [Report issues here](https://github.com/coder/coder/issues/new). -There are a few ways to install Coder: [install script](https://coder.com/docs/coder-oss/latest/install#installsh) (macOS, Linux), [docker-compose](https://coder.com/docs/coder-oss/latest/install#docker-compose), or [manually](https://coder.com/docs/coder-oss/latest/install#manual) via the latest release (macOS, Windows, and Linux). +The easiest way to install Coder is to use our [install script](https://github.com/coder/coder/blob/main/install.sh) for Linux and macOS. -If you use the install script, you can preview what occurs during the install process: +To install, run: -```sh -curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run +```bash +curl -L https://coder.com/install.sh | sh ``` -To install, run: +You can preview what occurs during the install process: -```sh -curl -fsSL https://coder.com/install.sh | sh +```bash +curl -L https://coder.com/install.sh | sh -s -- --dry-run ``` +You can modify the installation process by including flags. Run the help command for reference: + +```bash +curl -L https://coder.com/install.sh | sh -s -- --help +``` + +> See [install](docs/install.md) for additional methods. + Once installed, you can start a production deployment with a single command: ```sh