Add README with install and usage instructions

This commit is contained in:
Ian Johannesen
2026-03-19 10:29:17 +01:00
parent ecc36cfaaa
commit 0c1a797130

41
README.md Normal file
View File

@@ -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.