Skip to content

Commit 0f8f45e

Browse files
committed
docs: slim down readme
1 parent ecc83dd commit 0f8f45e

File tree

1 file changed

+13
-19
lines changed

1 file changed

+13
-19
lines changed

README.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,36 +8,30 @@ Discord"](https://img.shields.io/badge/join-us%20on%20Discord-gray.svg?longCache
88
Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq)
99
[![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder)
1010

11-
## Run Coder _now_
12-
13-
`curl -L https://coder.com/install.sh | sh`
14-
15-
## What Coder does
16-
17-
Coder creates remote development machines so you can develop your code from anywhere. #coder
18-
19-
> **Note**:
20-
> Coder is in an alpha state, but any serious bugs are P1 for us so [please report them](https://github.com/coder/coder/issues/new/choose).
11+
Coder creates remote development machines so your team can develop from anywhere.
2112

2213
<p align="center">
2314
<img src="./docs/images/hero-image.png">
2415
</p>
2516

17+
**Manage less**
18+
19+
- Ensure your entire team is using the same tools and resources
20+
- Rollout critical updates to your developers with one command
21+
- Automatically shut down expensive cloud resources
22+
- Keep your source code and data behind your firewall
23+
2624
**Code more**
2725

2826
- Build and test faster
2927
- Leveraging cloud CPUs, RAM, network speeds, etc.
3028
- Access your environment from any place on any client (even an iPad)
3129
- Onboard instantly then stay up to date continuously
3230

33-
**Manage less**
31+
## Getting Started
3432

35-
- Ensure your entire team is using the same tools and resources
36-
- Rollout critical updates to your developers with one command
37-
- Automatically shut down expensive cloud resources
38-
- Keep your source code and data behind your firewall
39-
40-
## Installing Coder
33+
> **Note**:
34+
> Coder is in an alpha state. [Report issues here](https://github.com/coder/coder/issues/new).
4135
4236
There are a few ways to install Coder: [install script](./docs/install.md#installsh) (macOS, Linux), [docker-compose](./docs/install.md#docker-compose), or [manually](./docs/install.md#manual) via the latest release (macOS, Windows, and Linux).
4337

@@ -59,7 +53,7 @@ Once installed, you can run a temporary deployment in dev mode (all data is in-m
5953
coder server --dev
6054
```
6155

62-
Use `coder --help` to get a complete list of flags and environment variables.
56+
Use `coder --help` to get a complete list of flags and environment variables. For a full walkthrough, follow [this guide](./docs/walkthrough.md).
6357

6458
## Documentation
6559

@@ -82,7 +76,7 @@ _Last updated: 5/27/22_
8276

8377
## Community
8478

85-
Join the community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq) #coder!
79+
Join our community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq)!
8680

8781
[Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose)
8882

0 commit comments

Comments
 (0)