Envbuilder: tweak README page

[mtojek]

README page for coder/envbuilder has a bit raw design. Let's add a fancy logo, some badges, maybe extract some parts of the README to a separate docs directory.

@mafredri @johnstcn Any thoughts or more ideas?

[johnstcn]

I like the idea of extracting parts of the README into docs and fleshing out more of docs/examples.

[mafredri]

This can definitely use some work, but I quite the structure of what ChatGPT came up with. (Source: https://chatgpt.com/share/e/66ec3d56-150c-8006-be8f-08c855075c5b)

---

Envbuilder

Welcome to Envbuilder 👋

Envbuilder is a tool to help developers create and manage development environments using Docker, Kubernetes, and OpenShift. Whether you’re new to containers or a seasoned pro, Envbuilder makes it easy to build, customize, and iterate on your environment, using devcontainer.json and Dockerfiles.

Why use Envbuilder?

• Flexible: Works with Docker, Kubernetes, and OpenShift.
• Fast: Cache image layers for speedy rebuilds.
• Customizable: Modify environments using devcontainer.json and Dockerfiles.

Join us in the Envbuilder Discord for help and community discussions!

---

Quickstart 🚀

Want to dive right in? Here's the easiest way to get started:

Run the Envbuilder Docker container that builds an image from a Dockerfile and runs your script.

docker run -it --rm \
    -v /tmp/envbuilder:/workspaces \
    -e ENVBUILDER_GIT_URL=https://github.com/coder/envbuilder-starter-devcontainer \
    -e ENVBUILDER_INIT_SCRIPT=bash \
    ghcr.io/coder/envbuilder

To explore more examples, tips, and advanced usage, check out the following guides:

• Using Envbuilder with Docker
• Advanced Kubernetes Configuration
• Setting Up Cache Layers

---

Usage with Coder 🖥️

If you’re using Coder for cloud-based development environments, Envbuilder is compatible and easy to integrate.

Some important things to note:

• Your ENVBUILDER_INIT_SCRIPT should include coder_agent.main.init_script for workspace connectivity.
• Ensure your container has a download tool (curl, wget, etc.) to fetch the agent binary.

For more details on Coder integration, see our Coder Integration Guide.

---

Customization 🛠️

Envbuilder provides a wide array of configuration options to suit your project’s needs, including:

• Git authentication methods (HTTP and SSH).
• Docker-in-Docker support.
• Custom SSL certificates.

For more in-depth information, visit our Configuration Guide.

---

Contributing 🧑‍💻

We’re always open to new ideas and contributions! Feel free to submit an issue or PR. Don’t forget to check out our Contributing Guide to get started.