Skip to content

docs: slim down readme #2140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 8, 2022
Merged

docs: slim down readme #2140

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0b6a177
docs: move docs table of contents to docs/index.md
jsjoeio Jun 7, 2022
2d942c5
docs: move how it works and IDE support to about.md
jsjoeio Jun 7, 2022
ecc83dd
docs: move readme steps to walkthrough
jsjoeio Jun 7, 2022
0f8f45e
docs: slim down readme
jsjoeio Jun 7, 2022
9238232
refactor: walkthrough -> quickstart
jsjoeio Jun 8, 2022
5c40887
docs: minor edits
jsjoeio Jun 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: slim down readme
  • Loading branch information
@jsjoeio
jsjoeio committed Jun 7, 2022
commit 0f8f45e486cb6fd6860e61b18cffed024501f517
32 changes: 13 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,36 +8,30 @@ Discord"](https://img.shields.io/badge/join-us%20on%20Discord-gray.svg?longCache
Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq)
[![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder)

## Run Coder _now_

`curl -L https://coder.com/install.sh | sh`

## What Coder does

Coder creates remote development machines so you can develop your code from anywhere. #coder

> **Note**:
> 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).
Coder creates remote development machines so your team can develop from anywhere.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep it short and simple.


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

**Manage less**

- Ensure your entire team is using the same tools and resources
- Rollout critical updates to your developers with one command
- Automatically shut down expensive cloud resources
- Keep your source code and data behind your firewall

**Code more**

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

**Manage less**
## Getting Started

- Ensure your entire team is using the same tools and resources
- Rollout critical updates to your developers with one command
- Automatically shut down expensive cloud resources
- Keep your source code and data behind your firewall

## Installing Coder
> **Note**:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Important, but they don't need to know this until they go to install and use it.

> 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](./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).

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

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

## Documentation

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

## Community

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

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

Expand Down