Skip to content

Commit 6f12850

Browse files
authored
chore(README.md): add example for specifying branch (#451)
1 parent d045c1c commit 6f12850

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,11 @@ Build development environments from a Dockerfile on Docker, Kubernetes, and Open
1919

2020
## Getting Started
2121

22-
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.
23-
24-
> **Note**: The `/tmp/envbuilder` directory persists demo data between commands. You can choose a different directory if needed.
22+
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.
2523

24+
> **Tips**:
25+
> - The `/tmp/envbuilder` directory persists demo data between commands. You can choose a different directory if needed.
26+
> - 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`.
2627
```bash
2728
docker run -it --rm
2829
-v /tmp/envbuilder:/workspaces

0 commit comments

Comments
 (0)