Skip to content

Commit 8830ddf

Browse files
kylecarbskylecarbs
authored
docs: update the readme to reduce unnecessary text (#5837)
The README was starting to get quite large, and I felt it was a bit bloaty. - Removes Twitter badge (the API was removed, so it wasn't working anyways) - Adds tagline to the title (an experiment, but worth a shot) - Reduces highlights - Removes recommended reading (people want to get started asap on a repo) - Updates doc links `/docs/coder-oss` -> `/docs/v2` - Moves comparison to the bottom - Removes adopters.md (we never promoted this, so it hasn't been used)
1 parent 08412fd commit 8830ddf

File tree

2 files changed

+18
-49
lines changed

2 files changed

+18
-49
lines changed

‎ADOPTERS.md

-13
This file was deleted.

‎README.md

+18-36
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,25 @@
1-
# Coder
1+
# Coder — Your Self-Hosted Remote Development Platform
22

33
[!["Join us on
44
Discord"](https://img.shields.io/badge/join-us%20on%20Discord-gray.svg?longCache=true&logo=discord&colorB=green)](https://coder.com/chat?utm_source=github.com/coder/coder&utm_medium=github&utm_campaign=readme.md)
55
[![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder)
66
[![Go Reference](https://pkg.go.dev/badge/github.com/coder/coder.svg)](https://pkg.go.dev/github.com/coder/coder)
7-
[![Twitter
8-
Follow](https://img.shields.io/twitter/follow/coderhq?label=%40coderhq&style=social)](https://twitter.com/coderhq)
97

10-
Software development on your infrastructure. Offload your team's development from local workstations to cloud servers. Onboard developers in minutes. Build, test and compile at the speed of the cloud. Keep your source code and data behind your firewall.
8+
Offload your team's development from local workstations to cloud servers. Onboard developers in minutes. Build, test and compile at the speed of the cloud. Keep your source code and data behind your firewall.
119

1210
> "By leveraging Terraform, Coder lets developers run any IDE on any compute platform including on-prem, AWS, Azure, GCP, DigitalOcean, Kubernetes, Docker, and more, with workspaces running on Linux, Windows, or Mac." - **Kevin Fishner Chief of Staff at [HashiCorp](https://hashicorp.com/)**
1311
1412
<p align="center">
1513
<img src="./docs/images/hero-image.png">
1614
</p>
1715

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

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

32-
## Recommended Reading
33-
34-
- [How our development team shares one giant bare metal machine](https://coder.com/blog/how-our-development-team-shares-one-giant-bare-metal-machine?utm_source=github.com/coder/coder&utm_medium=github&utm_campaign=readme.md)
35-
- [Laptop development is dead: why remote development is the future](https://medium.com/@elliotgraebert/laptop-development-is-dead-why-remote-development-is-the-future-f92ce103fd13)
36-
- [Learn how Palantir improved build times by 78% with coder](https://blog.palantir.com/the-benefits-of-remote-ephemeral-workspaces-1a1251ed6e53).
37-
- [A software development environment is not just a container](https://coder.com/blog/not-a-container?utm_source=github.com/coder/coder&utm_medium=github&utm_campaign=readme.md).
38-
3923
## Getting Started
4024

4125
The easiest way to install Coder is to use our
@@ -73,18 +57,30 @@ coder server
7357
coder server --postgres-url <url> --access-url <url>
7458
```
7559

76-
> <sup>1</sup> The embedded database is great for trying out Coder with small deployments, but do consider using an external database for increased assurance and control.
60+
> <sup>1</sup> The automatic setup is great for trying out Coder with small deployments, but do consider using an external database for increased assurance and control.
7761
78-
Use `coder --help` to get a complete list of flags and environment variables. Use our [quickstart guide](https://coder.com/docs/coder-oss/latest/quickstart) for a full walkthrough.
62+
Use `coder --help` to get a complete list of flags and environment variables. Use our [quickstart guide](https://coder.com/docs/v2/latest/quickstart) for a full walkthrough.
7963

8064
## Documentation
8165

82-
Visit our docs [here](https://coder.com/docs/coder-oss).
66+
Visit our docs [here](https://coder.com/docs/v2).
8367

8468
## Templates
8569

8670
Find our templates [here](./examples/templates).
8771

72+
## Community and Support
73+
74+
Join our community on [Discord](https://coder.com/chat?utm_source=github.com/coder/coder&utm_medium=github&utm_campaign=readme.md) and [Twitter](https://twitter.com/coderhq)!
75+
76+
[Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose)
77+
78+
## Contributing
79+
80+
Read the [contributing docs](https://coder.com/docs/v2/latest/CONTRIBUTING).
81+
82+
Find our list of contributors [here](https://github.com/coder/coder/graphs/contributors).
83+
8884
## Comparison
8985

9086
Please file [an issue](https://github.com/coder/coder/issues/new) if any information is out of date. Also refer to:
@@ -107,17 +103,3 @@ Please file [an issue](https://github.com/coder/coder/issues/new) if any informa
107103
| [Microsoft DevBox](https://coder.com/blog/the-self-hosting-paradox?utm_source=github.com/coder/coder?utm_source=github.com/coder/coder&utm_medium=github&utm_campaign=readme.md) | Platform | SaaS (Preview, not GA) | Pay Microsoft | Yes | Australia East, Europe West, Japan East, Canada Central, UK South, US East, US East 2, US South Central, and US West 3 | Microsoft Azure Virtual Machine | N/A | Not generally available, offered in preview mode. | Windows Virtual Machine | Any application that runs on Windows via Microsoft Remote Desktop |
108104

109105
_Last updated: 14/12/2022_
110-
111-
## Community and Support
112-
113-
Join our community on [Discord](https://coder.com/chat?utm_source=github.com/coder/coder&utm_medium=github&utm_campaign=readme.md) and [Twitter](https://twitter.com/coderhq)!
114-
115-
[Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose)
116-
117-
## Contributing
118-
119-
If you're using Coder in your organization, please try to add your company name to the [ADOPTERS.md](./ADOPTERS.md). It really helps the project to gain momentum and credibility. It's a small contribution back to the project with a big impact.
120-
121-
Read the [contributing docs](https://coder.com/docs/coder-oss/latest/CONTRIBUTING).
122-
123-
Find our list of contributors [here](https://github.com/coder/coder/graphs/contributors).

0 commit comments

Comments
 (0)