diff --git a/README.md b/README.md index a59f0f1..7a1da04 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,30 @@ A CLI tool for making commits to many subrepos after a distributed change. ## Installation +### Using bbin (Recommended) + +Install directly from Gitea using SSH: + +```bash +# Install from your Gitea repository via SSH +bbin install git@git.ajet.fyi:ajet-industries/commitly.git + +# Install a specific version using a git tag +bbin install git@git.ajet.fyi:ajet-industries/commitly.git --git/tag v1.0.0 + +# Install the latest commit +bbin install git@git.ajet.fyi:ajet-industries/commitly.git --latest-sha +``` + +This will install `commitly` to `~/.local/bin/commitly` (make sure `~/.local/bin` is in your PATH). + +**Note:** Requires [bbin](https://github.com/babashka/bbin) to be installed first: +```bash +bash < <(curl -s https://raw.githubusercontent.com/babashka/bbin/main/bbin) +``` + +### Manual Installation + ```bash # Make the script executable chmod +x commitly