From 96672cc8abee79c2164c5247422a6a59b5021760 Mon Sep 17 00:00:00 2001 From: Cian Johnston Date: Wed, 5 Feb 2025 20:42:15 +0000 Subject: [PATCH] chore(README.md): add example for specifying branch This is somewhat hidden under `docs/usage-with-coder.md` --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 15726b4..d508f00 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,11 @@ Build development environments from a Dockerfile on Docker, Kubernetes, and Open ## Getting Started -The easiest way to get started is by running the `envbuilder` Docker container that clones a repository, builds the image from a Dockerfile, and runs the `$ENVBUILDER_INIT_SCRIPT` in the freshly built container. - -> **Note**: The `/tmp/envbuilder` directory persists demo data between commands. You can choose a different directory if needed. +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**: +> - The `/tmp/envbuilder` directory persists demo data between commands. You can choose a different directory if needed. +> - To clone a different branch, you append it to `ENVBUILDER_GIT_URL` in the form `#refs/heads/my-branch`. For example: `https://github.com/coder/envbuilder-starter-devcontainer#refs/heads/boring-prompt`. ```bash docker run -it --rm -v /tmp/envbuilder:/workspaces