diff --git a/README.md b/README.md index 6bf3653..8436d2a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- + @@ -7,6 +7,10 @@ # Envbuilder + +> [!WARNING] +> `envbuilder` is in maintenance mode and no new features are planned, please explore alternative options. + ![envbuilder](https://github.com/user-attachments/assets/0a49f5cd-2040-4a07-84ba-8b765b954e57) _(Video created using [asciinema](https://github.com/asciinema/asciinema) and [agg](https://github.com/asciinema/agg))_ @@ -19,6 +23,17 @@ Build development environments from a Dockerfile on Docker, Kubernetes, and Open ## Getting Started +### In Coder + +> [!IMPORTANT] +> The updated way of using DevContainers within Coder is now the built-in [DevContainers CLI integration](https://coder.com/docs/@v2.36.1/admin/integrations/devcontainers#dev-containers-integration), it is heavily suggested to go with this approach. +> +> Feel free to join the [Coder Discord server](https://cdr.co/discord-4mHyQ3BJP8) and ask for help with finding out the best way to use DevContainers in your Coder deployment. + +Browse the Coder Registry for [example templates that use `envbuilder` to deploy DevContainers](https://registry.coder.com/templates?search=tag%3Adevcontainer). + +### Docker + The easiest way to get started is by running the `envbuilder` Docker container that clones a repository specified by `ENVBUILDER_GIT_URL`, builds the image from a Dockerfile or `devcontainer.json`, and runs the `$ENVBUILDER_INIT_SCRIPT` in the freshly built container. > **Tips**: