Skip to content

Commit 55877fd

Browse files
authored
Merge pull request #93 from tstromberg/main
Introduce homebrew tap for macOS & Linux
2 parents 7ed1d3a + f2f8e29 commit 55877fd

File tree

3 files changed

+19
-22
lines changed

3 files changed

+19
-22
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ release:
331331
exit 1; \
332332
fi
333333
@echo "Creating and pushing tag $(VERSION)..."
334-
@git tag -a "$(VERSION)" -m "Release $(VERSION)"
334+
@git tag "$(VERSION)"
335335
@git push origin main
336336
@git push origin "$(VERSION)"
337337
@echo "✓ Release $(VERSION) created and pushed successfully"

README.md

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,56 +12,53 @@ The only PR tracker that honks at you when you're the bottleneck. Now shipping w
1212
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.
1313

1414
![Review Goose Screenshot](media/screenshot.png)
15-
## macOS Quick Start ⚡ (Get Honked At)
1615

17-
Install dependencies:
16+
## macOS Quick Start ⚡ (Get Honked At)
1817

19-
```bash
20-
brew install gh go
21-
```
18+
Homebrew users can get the party started quickly:
2219

23-
Confirm that `gh` is properly authenticated:
20+
```shell
2421

25-
```
22+
brew install --cask codeGROOVE-dev/homebrew-tap/review-goose
2623
gh auth status || gh auth login
2724
```
2825

29-
Build & run:
26+
Open `/Applications/Review Goose.app`. To be persistently annoyed every time you login, click the `Start at Login` menu item.
3027

31-
```bash
32-
git clone https://github.com/ready-to-review/goose.git
33-
cd goose && make run
34-
```
28+
## Homebrew on Linux Quick Start ⚡
3529

36-
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.
30+
On a progressive Linux distribution that includes Homebrew, such as [Bluefin](https://projectbluefin.io/)? You are just a cut and paste away from excitement:
3731

38-
## Linux/BSD/Windows Quick Start
32+
```shell
33+
brew install codeGROOVE-dev/homebrew-tap/review-goose
34+
gh auth status || gh auth login
35+
```
3936

40-
1. Install the GitHub CLI and Go via your platforms recommended methods
41-
2. Compile and install Goose:
37+
## Linux/BSD/Windows Medium Start
38+
39+
1. Install the [GitHub CLI](https://cli.github.com/) and [Go](https://go.dev/dl/) via your platforms recommended methods
40+
2. Install Review Goose:
4241

4342
```bash
4443
go install github.com/codeGROOVE-dev/goose/cmd/review-goose@latest
4544
```
4645

4746
3. Copy goose from $HOME/go/bin to wherever you prefer
48-
4. Add goose to your auto-login so you never foget about PRs again
47+
4. Add goose to your auto-login so you never forget about PRs again
4948

5049
## Using a fine-grained access token
5150

52-
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:
51+
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:
5352

5453
- **Pull requests**: Read
5554
- **Metadata**: Read
5655

5756
You can then use the token like so:
5857

5958
```bash
60-
env GITHUB_TOKEN=your_token_here goose
59+
env GITHUB_TOKEN=your_token_here review-goose
6160
```
6261

63-
We don't yet persist fine-grained tokens to disk - PR's welcome!
64-
6562
## Usage
6663

6764
- **macOS/Windows**: Click the tray icon to show the menu

media/logo-small.png

-8.56 KB
Loading

0 commit comments

Comments
 (0)