From ea2f793b04e0e0d0ccb1920e850f230305240340 Mon Sep 17 00:00:00 2001
From: Cesar Flores <dev@esauflores.com>
Date: Wed, 4 Mar 2026 01:43:04 +0700
Subject: [PATCH] docs: add README

---
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4e84522
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# dev-tools
+
+Populates a shared `dev-tools` Docker volume with dev tools using [mise](https://mise.jdx.dev/). Run once, mount everywhere.
+
+## Prerequisites
+
+Create the external volume:
+
+```bash
+docker volume create dev-tools
+```
+
+Optionally, set a GitHub token to avoid API rate limits:
+
+```bash
+cp .env.example .env
+# fill in GITHUB_TOKEN
+```
+
+## Usage
+
+```bash
+docker compose up
+```
+
+## Tools
+
+| Category         | Tools                                              |
+| ---------------- | -------------------------------------------------- |
+| Languages        | Node 24, Python 3.11, Go 1.26, DuckDB 1            |
+| Package managers | uv                                                 |
+| Secrets          | sops, age                                          |
+| Infra            | mc (MinIO client), Supabase CLI                    |
+| Dev utilities    | bat, eza, ripgrep, fzf, jq, yq, just, gh, starship |
+
+## Consuming the volume
+
+```yaml
+volumes:
+  - dev-tools:/tools
+environment:
+  - PATH=/tools/shims:${PATH}
+
+volumes:
+  dev-tools:
+    name: dev-tools
+    external: true
+```
+
+## Updating tools
+
+Edit `mise.toml`, bump versions, re-run `docker compose up`.