Skip to content

Commit fb15bd3

Browse files
chore: update README.md (#12)
1 parent 8772e2b commit fb15bd3

File tree

3 files changed

+4
-29
lines changed

3 files changed

+4
-29
lines changed

README.md

+2-27
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,8 @@ This repository contains a collection of [dev container Features](https://contai
44

55
## Available Features
66

7-
### `code-server`
8-
9-
The `code-server` feature installs [code-server](https://github.com/coder/code-server), which allows you to run VS Code in the browser.
10-
11-
```jsonc
12-
{
13-
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
14-
"features": {
15-
"ghcr.io/coder/devcontainer-features/code-server:1": {
16-
"host": "127.0.0.1",
17-
"port": "8080",
18-
"args": "",
19-
"extensions": ""
20-
}
21-
}
22-
}
23-
```
24-
25-
#### Options
26-
27-
| Option | Type | Default | Description |
28-
|--------|------|---------|-------------|
29-
| `host` | string | `127.0.0.1` | The address to bind to when starting code-server |
30-
| `port` | string | `8080` | The port to bind to when starting code-server |
31-
| `args` | string | `""` | Additional arguments to pass to code-server |
32-
| `extensions` | string | `""` | Comma-separated list of VS Code extensions to install |
7+
- [code-server](./src/code-server/README.md) - VS Code in the browser
338

349
## Contributing
3510

36-
For information about contributing to this repository, including how to publish features, please see [CONTRIBUTING.md](./CONTRIBUTING.md).
11+
For information about contributing to this repository, including how to publish features, please see [CONTRIBUTING.md](./CONTRIBUTING.md).

src/code-server/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
# code-server (code-server)
33

4-
VS Code in the browser
4+
VS Code in the browser ([code-server](https://github.com/coder/code-server))
55

66
## Example Usage
77

src/code-server/devcontainer-feature.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "code-server",
33
"id": "code-server",
44
"version": "1.0.0",
5-
"description": "VS Code in the browser",
5+
"description": "VS Code in the browser ([code-server](https://github.com/coder/code-server))",
66
"options": {
77
"absProxyBasePath": {
88
"type": "string",

0 commit comments

Comments
 (0)