diff --git a/README.md b/README.md index 99fc654..5ac8a39 100644 --- a/README.md +++ b/README.md @@ -4,33 +4,8 @@ This repository contains a collection of [dev container Features](https://contai ## Available Features -### `code-server` - -The `code-server` feature installs [code-server](https://github.com/coder/code-server), which allows you to run VS Code in the browser. - -```jsonc -{ - "image": "mcr.microsoft.com/devcontainers/base:ubuntu", - "features": { - "ghcr.io/coder/devcontainer-features/code-server:1": { - "host": "127.0.0.1", - "port": "8080", - "args": "", - "extensions": "" - } - } -} -``` - -#### Options - -| Option | Type | Default | Description | -|--------|------|---------|-------------| -| `host` | string | `127.0.0.1` | The address to bind to when starting code-server | -| `port` | string | `8080` | The port to bind to when starting code-server | -| `args` | string | `""` | Additional arguments to pass to code-server | -| `extensions` | string | `""` | Comma-separated list of VS Code extensions to install | +- [code-server](./src/code-server/README.md) - VS Code in the browser ## Contributing -For information about contributing to this repository, including how to publish features, please see [CONTRIBUTING.md](./CONTRIBUTING.md). \ No newline at end of file +For information about contributing to this repository, including how to publish features, please see [CONTRIBUTING.md](./CONTRIBUTING.md). diff --git a/src/code-server/README.md b/src/code-server/README.md index 77d3165..8bb6d4c 100644 --- a/src/code-server/README.md +++ b/src/code-server/README.md @@ -1,7 +1,7 @@ # code-server (code-server) -VS Code in the browser +VS Code in the browser ([code-server](https://github.com/coder/code-server)) ## Example Usage diff --git a/src/code-server/devcontainer-feature.json b/src/code-server/devcontainer-feature.json index 4e0902b..f8b0835 100644 --- a/src/code-server/devcontainer-feature.json +++ b/src/code-server/devcontainer-feature.json @@ -2,7 +2,7 @@ "name": "code-server", "id": "code-server", "version": "1.0.0", - "description": "VS Code in the browser", + "description": "VS Code in the browser ([code-server](https://github.com/coder/code-server))", "options": { "absProxyBasePath": { "type": "string",