Skip to content

Commit 8a2f38a

Browse files
authored
chore: simplify readme (coder#12639)
* chore: simplify readme Closes coder#12628. * Add link to module registry
1 parent c84d96b commit 8a2f38a

File tree

2 files changed

+11
-22
lines changed

2 files changed

+11
-22
lines changed

README.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
[Quickstart](#quickstart) | [Docs](https://coder.com/docs) | [Why Coder](https://coder.com/why) | [Enterprise](https://coder.com/docs/v2/latest/enterprise)
2424

2525
[![discord](https://img.shields.io/discord/747933592273027093?label=discord)](https://discord.gg/coder)
26-
[![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder)
2726
[![release](https://img.shields.io/github/v/release/coder/coder)](https://github.com/coder/coder/releases/latest)
2827
[![godoc](https://pkg.go.dev/badge/github.com/coder/coder.svg)](https://pkg.go.dev/github.com/coder/coder)
2928
[![Go Report Card](https://goreportcard.com/badge/github.com/coder/coder)](https://goreportcard.com/report/github.com/coder/coder)
@@ -53,8 +52,8 @@ curl -L https://coder.com/install.sh | sh
5352
# Start the Coder server (caches data in ~/.cache/coder)
5453
coder server
5554
56-
# Navigate to http://localhost:3000 to create your initial user
57-
# Create a Docker template, and provision a workspace
55+
# Navigate to http://localhost:3000 to create your initial user,
56+
# create a Docker template, and provision a workspace
5857
```
5958

6059
## Install
@@ -68,11 +67,11 @@ Releases.
6867
curl -L https://coder.com/install.sh | sh
6968
```
7069

71-
You can run the install script with `--dry-run` to see the commands that will be used to install without executing them. You can modify the installation process by including flags. Run the install script with `--help` for reference.
70+
You can run the install script with `--dry-run` to see the commands that will be used to install without executing them. Run the install script with `--help` for additional flags.
7271

7372
> See [install](https://coder.com/docs/v2/latest/install) for additional methods.
7473
75-
Once installed, you can start a production deployment<sup>1</sup> with a single command:
74+
Once installed, you can start a production deployment with a single command:
7675

7776
```shell
7877
# Automatically sets up an external access URL on *.try.coder.app
@@ -82,8 +81,6 @@ coder server
8281
coder server --postgres-url <url> --access-url <url>
8382
```
8483

85-
> <sup>1</sup> For production deployments, set up an external PostgreSQL instance for reliability.
86-
8784
Use `coder --help` to get a list of flags and environment variables. Use our [install guides](https://coder.com/docs/v2/latest/install) for a full walkthrough.
8885

8986
## Documentation
@@ -96,30 +93,26 @@ Browse our docs [here](https://coder.com/docs/v2) or visit a specific section be
9693
- [**Administration**](https://coder.com/docs/v2/latest/admin): Learn how to operate Coder
9794
- [**Enterprise**](https://coder.com/docs/v2/latest/enterprise): Learn about our paid features built for large teams
9895

99-
## Community and Support
96+
## Support
10097

10198
Feel free to [open an issue](https://github.com/coder/coder/issues/new) if you have questions, run into bugs, or have a feature request.
10299

103-
[Join our Discord](https://discord.gg/coder) or [Slack](https://cdr.co/join-community) to provide feedback on in-progress features, and chat with the community using Coder!
104-
105-
## Contributing
106-
107-
Contributions are welcome! Read the [contributing docs](https://coder.com/docs/v2/latest/CONTRIBUTING) to get started.
108-
109-
Find our list of contributors [here](https://github.com/coder/coder/graphs/contributors).
100+
[Join our Discord](https://discord.gg/coder) to provide feedback on in-progress features, and chat with the community using Coder!
110101

111-
## Related
102+
## Integrations
112103

113104
We are always working on new integrations. Feel free to open an issue to request an integration. Contributions are welcome in any official or community repositories.
114105

115106
### Official
116107

117108
- [**VS Code Extension**](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote): Open any Coder workspace in VS Code with a single click
118109
- [**JetBrains Gateway Extension**](https://plugins.jetbrains.com/plugin/19620-coder): Open any Coder workspace in JetBrains Gateway with a single click
110+
- [**Dev Container Builder**](https://github.com/coder/envbuilder): Build development environments using `devcontainer.json` on Docker, Kubernetes, and OpenShift
111+
- [**Module Registry**](https://registry.coder.com): Extend development environments with common use-cases
112+
- [**Kubernetes Log Stream**](https://github.com/coder/coder-logstream-kube): Stream Kubernetes Pod events to the Coder startup logs
119113
- [**Self-Hosted VS Code Extension Marketplace**](https://github.com/coder/code-marketplace): A private extension marketplace that works in restricted or airgapped networks integrating with [code-server](https://github.com/coder/code-server).
120114

121115
### Community
122116

123117
- [**Provision Coder with Terraform**](https://github.com/ElliotG/coder-oss-tf): Provision Coder on Google GKE, Azure AKS, AWS EKS, DigitalOcean DOKS, IBMCloud K8s, OVHCloud K8s, and Scaleway K8s Kapsule with Terraform
124-
- [**Coder GitHub Action**](https://github.com/marketplace/actions/update-coder-template): A GitHub Action that updates Coder templates
125-
- [**Various Templates**](./examples/templates/community-templates.md): Hetzner Cloud, Docker in Docker, and other templates the community has built.
118+
- [**Coder Template GitHub Action**](https://github.com/marketplace/actions/update-coder-template): A GitHub Action that updates Coder templates

examples/templates/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,3 @@ git clone https://github.com/coder/coder
1313
cd examples/templates/aws-linux
1414
coder templates push
1515
```
16-
17-
## Community Templates
18-
19-
See the list of [Community Templates](./community-templates.md).

0 commit comments

Comments
 (0)