Skip to content

Commit 2ce89c4

Browse files
authored
Update README.md (#243)
* Update README.md * Update to website
1 parent 9366ef7 commit 2ce89c4

File tree

1 file changed

+12
-20
lines changed

1 file changed

+12
-20
lines changed

README.md

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,28 @@
44
<td style="width: 140px; text-align: center;"><a href="https://github.com/devcontainers"><img width="128px" src="https://raw.githubusercontent.com/microsoft/fluentui-system-icons/78c9587b995299d5bfc007a0077773556ecb0994/assets/Cube/SVG/ic_fluent_cube_32_filled.svg" alt="devcontainers organization logo"/></a></td>
55
<td>
66
<strong>Development Container 'Features'</strong><br />
7-
<i>A set of simple and reusable 'features'. Quickly add a language/tool/CLI to a development container.
7+
<i>A set of simple and reusable Features. Quickly add a language/tool/CLI to a development container.
88
</td>
99
</tr></table>
1010

1111
'Features' are self-contained units of installation code and development container configuration. Features are designed
1212
to install atop a wide-range of base container images (**this repo focuses on `debian` based images**).
1313

14-
Missing a CLI or language in your otherwise _perfect_ container image? Add the relevant 'feature' to the `features`
14+
Missing a CLI or language in your otherwise _perfect_ container image? Add the relevant Feature to the `features`
1515
property of a [`devcontainer.json`](https://containers.dev/implementors/json_reference/#general-properties). A
1616
[tool supporting the dev container specification](https://containers.dev/supporting) is required to build a development
1717
container.
1818

19-
⚠️ Development container 'features' are a
20-
[**proposed**](https://github.com/devcontainers/spec/blob/main/proposals/devcontainer-features.md) addition to the
21-
[development container specification](https://containers.dev/implementors/spec/). **Please note that 'features' are in
22-
preview and subject to breaking changes**.
23-
24-
Once the [**proposed**](https://github.com/devcontainers/spec/blob/main/proposals/devcontainer-features.md)
25-
specification is accepted, implementation details will be published at
26-
[https://containers.dev](https://containers.dev/).
27-
19+
You may learn about Features at [containers.dev](https://containers.dev/implementors/features/), which is the website for the dev container specification.
2820

2921
## Usage
3022

31-
To reference a feature from this repository, add the desired features to a `devcontainer.json`. Each feature has a `README.md` that shows how to reference the feature and which options are available for that feature.
23+
To reference a Feature from this repository, add the desired Features to a `devcontainer.json`. Each Feature has a `README.md` that shows how to reference the Feature and which options are available for that Feature.
3224

3325
The example below installs the `go` and `docker-in-docker` declared in the [`./src`](./src) directory of this
3426
repository.
3527

36-
See the relevant feature's README for supported options.
28+
See the relevant Feature's README for supported options.
3729

3830
```jsonc
3931
"name": "my-project-devcontainer",
@@ -51,7 +43,7 @@ See the relevant feature's README for supported options.
5143

5244
The `:latest` version annotation is added implicitly if omitted. To pin to a specific package version
5345
([example](https://github.com/devcontainers/features/pkgs/container/features/go/versions)), append it to the end of the
54-
feature. Features follow semantic versioning conventions, so you can pin to a major version `:1`, minor version `:1.0`, or patch version `:1.0.0` by specifying the appropriate label.
46+
Feature. Features follow semantic versioning conventions, so you can pin to a major version `:1`, minor version `:1.0`, or patch version `:1.0.0` by specifying the appropriate label.
5547

5648
```jsonc
5749
"features": {
@@ -63,7 +55,7 @@ feature. Features follow semantic versioning conventions, so you can pin to a ma
6355

6456
The [devcontainer CLI reference implementation](https://github.com/devcontainers/cli) (or a
6557
[supporting tool](https://containers.dev/supporting)) can be used to build a project's dev container declaring
66-
'features'.
58+
Features.
6759

6860
```bash
6961
git clone <my-project-with-devcontainer>
@@ -97,23 +89,23 @@ devcontainer build --workspace-folder <path-to-my-project-with-devcontainer>
9789
...
9890
```
9991

100-
- [`src`](src) - A collection of subfolders, each declaring a feature. Each subfolder contains at least a
92+
- [`src`](src) - A collection of subfolders, each declaring a Feature. Each subfolder contains at least a
10193
`devcontainer-feature.json` and an `install.sh` script.
10294
- [`test`](test) - Mirroring `src`, a folder-per-feature with at least a `test.sh` script. The
10395
[`devcontainer` CLI](https://github.com/devcontainers/cli) will execute
10496
[these tests in CI](https://github.com/devcontainers/features/blob/main/.github/workflows/test-all.yaml).
10597

10698
## Contributions
10799

108-
### Creating your own collection of features
100+
### Creating your own collection of Features
109101

110-
The [feature distribution specification](https://github.com/devcontainers/spec/blob/main/proposals/devcontainer-features-distribution.md) outlines a pattern for community members and organizations to self-author features in repositories they control.
102+
The [Feature distribution specification](https://containers.dev/implementors/features-distribution/) outlines a pattern for community members and organizations to self-author Features in repositories they control.
111103

112-
A template repo [`devcontainers/feature-template`](https://github.com/devcontainers/feature-template) and [GitHub Action](https://github.com/devcontainers/action) are available to help bootstrap self-authored features.
104+
A template repo [`devcontainers/feature-template`](https://github.com/devcontainers/feature-template) and [GitHub Action](https://github.com/devcontainers/action) are available to help bootstrap self-authored Features.
113105

114106
We are eager to hear your feedback on self-authoring! Please provide comments and feedback on [spec issue #70](https://github.com/devcontainers/spec/issues/70).
115107

116108
### Contributing to this repository
117109

118110
This repository will accept improvement and bug fix contributions related to the
119-
[current set of maintained features](./src).
111+
[current set of maintained Features](./src).

0 commit comments

Comments
 (0)