diff --git a/Makefile b/Makefile index 7d08a83..19e73e7 100644 --- a/Makefile +++ b/Makefile @@ -331,7 +331,7 @@ release: exit 1; \ fi @echo "Creating and pushing tag $(VERSION)..." - @git tag -a "$(VERSION)" -m "Release $(VERSION)" + @git tag "$(VERSION)" @git push origin main @git push origin "$(VERSION)" @echo "✓ Release $(VERSION) created and pushed successfully" diff --git a/README.md b/README.md index fd2b448..fab6932 100644 --- a/README.md +++ b/README.md @@ -12,44 +12,43 @@ The only PR tracker that honks at you when you're the bottleneck. Now shipping w Lives in your menubar like a tiny waterfowl of productivity shame, watching your GitHub PRs and making aggressive bird sounds when you're blocking someone's code from seeing the light of production. ![Review Goose Screenshot](media/screenshot.png) -## macOS Quick Start ⚡ (Get Honked At) -Install dependencies: +## macOS Quick Start ⚡ (Get Honked At) -```bash -brew install gh go -``` +Homebrew users can get the party started quickly: -Confirm that `gh` is properly authenticated: +```shell -``` +brew install --cask codeGROOVE-dev/homebrew-tap/review-goose gh auth status || gh auth login ``` -Build & run: +Open `/Applications/Review Goose.app`. To be persistently annoyed every time you login, click the `Start at Login` menu item. -```bash -git clone https://github.com/ready-to-review/goose.git -cd goose && make run -``` +## Homebrew on Linux Quick Start ⚡ -This will will cause the goose to implant itself into `/Applications/Review Goose.app` for future invocations. To be persistently annoyed every time you login, click the `Start at Login` menu item. +On a progressive Linux distribution that includes Homebrew, such as [Bluefin](https://projectbluefin.io/)? You are just a cut and paste away from excitement: -## Linux/BSD/Windows Quick Start +```shell +brew install codeGROOVE-dev/homebrew-tap/review-goose +gh auth status || gh auth login +``` -1. Install the GitHub CLI and Go via your platforms recommended methods -2. Compile and install Goose: +## Linux/BSD/Windows Medium Start + +1. Install the [GitHub CLI](https://cli.github.com/) and [Go](https://go.dev/dl/) via your platforms recommended methods +2. Install Review Goose: ```bash go install github.com/codeGROOVE-dev/goose/cmd/review-goose@latest ``` 3. Copy goose from $HOME/go/bin to wherever you prefer -4. Add goose to your auto-login so you never foget about PRs again +4. Add goose to your auto-login so you never forget about PRs again ## Using a fine-grained access token -If you want more control over which repositories the goose can access, you can use a [fine-grained personal access token](https://github.com/settings/personal-access-tokens/new) with the following permissions: +If you want more control over which repositories the goose can access - for example, only access to public repositories, you can use a [fine-grained personal access token](https://github.com/settings/personal-access-tokens/new) with the following permissions: - **Pull requests**: Read - **Metadata**: Read @@ -57,11 +56,9 @@ If you want more control over which repositories the goose can access, you can u You can then use the token like so: ```bash -env GITHUB_TOKEN=your_token_here goose +env GITHUB_TOKEN=your_token_here review-goose ``` -We don't yet persist fine-grained tokens to disk - PR's welcome! - ## Usage - **macOS/Windows**: Click the tray icon to show the menu diff --git a/media/logo-small.png b/media/logo-small.png index 539c509..deae3a2 100644 Binary files a/media/logo-small.png and b/media/logo-small.png differ