Skip to content

Commit 9306e1d

Browse files
committed
Update README
1 parent 1a32ec8 commit 9306e1d

File tree

1 file changed

+13
-19
lines changed

1 file changed

+13
-19
lines changed

README.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,6 @@ 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-
16-
## What It Does
17-
18-
- **Honks** when you're blocking someone's PR (authentic goose noises included)
19-
- **Jet sounds** when your own PR is ready for the next stage
20-
- **Smart turn-based assignment** - knows who is blocking a PR, knows when tests are failing, etc.
21-
- **Auto-start** on login (macOS)
22-
- **Auto-open** incoming PRs in your browser (off by default, rate-limited)
23-
- **Org Filtering** for orgs you may not care about in a home or work context
24-
- **Multi-platform** support for Linux, macOS, Windows, FreeBSD, whatever.
25-
26-
You can also visit the web-based dashboard at <https://dash.ready-to-review.dev/>
27-
28-
## Dependencies
29-
30-
- [go](https://go.dev/) 1.23.4 or higher
31-
- [gh](https://cli.github.com/), AKA the GitHub command-line utility
32-
3315
## macOS Quick Start ⚡ (Get Honked At)
3416

3517
Install dependencies:
@@ -53,7 +35,19 @@ cd goose && make run
5335

5436
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.
5537

56-
### Using a fine-grained access token
38+
## Linux/BSD/Windows Quick Start
39+
40+
1. Install the GitHub CLI and Go via your platforms recommended methods
41+
2. Compile and install Goose:
42+
43+
```bash
44+
go install github.com/codeGROOVE-dev/goose/cmd/goose@latest
45+
```
46+
47+
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
49+
50+
## Using a fine-grained access token
5751

5852
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:
5953

0 commit comments

Comments
 (0)