From 0c1a797130d176ce08d6125882bebc2166094e0d Mon Sep 17 00:00:00 2001
From: Ian Johannesen <ij@opsplaza.com>
Date: Thu, 19 Mar 2026 10:29:17 +0100
Subject: [PATCH] Add README with install and usage instructions

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7b348aa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# Homebrew Tap for vardrun
+
+## Install
+
+```bash
+brew tap ijohanne/vardrun https://git.unixpimps.net/ijohanne/vardrun-homebrew.git
+brew install vardrun
+```
+
+## Upgrade
+
+```bash
+brew update
+brew upgrade vardrun
+```
+
+## Uninstall
+
+```bash
+brew uninstall vardrun
+brew untap ijohanne/vardrun
+```
+
+## Supported platforms
+
+| OS    | Architecture |
+|-------|-------------|
+| macOS | Apple Silicon (arm64) |
+| macOS | Intel (amd64) |
+| Linux | arm64 |
+| Linux | amd64 |
+
+## Publishing new releases
+
+From the vardrun source repo, run:
+
+```bash
+GITEA_HOMEBREW_API_TOKEN=<token> nix run .#homebrew-release
+```
+
+This builds a static binary for the current platform, uploads it to the Gitea package registry, and updates the formula. Run once per target platform to populate all sha256 hashes.