From ed58ee94a713ac22f8a9d9a00141b21452a6a1aa Mon Sep 17 00:00:00 2001 From: Amolith Date: Wed, 11 Mar 2026 13:02:22 -0600 Subject: [PATCH] docs(install): point to releases.secluded.site --- README.md | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index a816ec7ff371b3b568bc8d0f3ba230034c447848..6216abab66a16b5d03db3c101dad248af6b61a6a 100644 --- a/README.md +++ b/README.md @@ -39,20 +39,16 @@ You need _both_ the binary and [the skill]. ### The binary -- Using [bin](https://github.com/marcosnils/bin) (highly recommended - because it's one tool to manage and update myriad CLI tools - distributed as statically-linked binaries, like _git-format_) - ```bash - bin install goinstall://git.secluded.site/git-format@latest - git-format install - ``` -- Using the [go toolchain](https://go.dev/dl) (upgrade with `git-format upgrade`) - ```bash - go install git.secluded.site/git-format@latest - git-format install - ``` - -The `git-format install` command creates symlinks so you can invoke it as `git +Pre-built binaries are available at +[releases.secluded.site/git-format/latest](https://releases.secluded.site/git-format/latest). + +- Using [mise](https://mise.jdx.dev/) (recommended), copy the snippet from the + releases page into your `mise.toml` or global `~/.config/mise/config.toml` to + automate updates. +- Without mise, or a similar tool, download the binary for your platform from + the releases page and place it somewhere in your `$PATH`. + +Then run `git-format install` tr create symlinks so you can invoke it as `git formatted-commit` and `git formatted-tag`. ## Contributions