Skip to content

Commit fafcf8d

Browse files
committed
More README improvements
1 parent 77fdbc8 commit fafcf8d

File tree

1 file changed

+13
-26
lines changed

1 file changed

+13
-26
lines changed

README.md

Lines changed: 13 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Ready-to-Review Goose 🪿
22

3-
![Experimental](https://img.shields.io/badge/status-experimental-orange)
3+
![Experimental](https://img.shields.io/badge/status-beta-orange)
44
![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20BSD%20%7C%20Windows-blue)
55
![Goose Noises](https://img.shields.io/badge/goose%20noises-100%25%20more-green)
66
[![GitHub](https://img.shields.io/github/stars/ready-to-review/goose?style=social)](https://github.com/ready-to-review/goose)
@@ -9,7 +9,6 @@ The only PR tracker that honks at you when you're the bottleneck. Now shipping w
99

1010
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.
1111

12-
> ⚠️ **EXPERIMENTAL**: This is very much a work in progress. The blocking logic has bugs. Linux/BSD/Windows support is untested. Here be dragons (and geese).
1312

1413
![PR Menubar Screenshot](media/screenshot.png)
1514

@@ -24,7 +23,7 @@ You can also visit the web-based equivalent at https://dash.ready-to-review.dev/
2423

2524
## macOS Quick Start ⚡ (How to Get Honked At)
2625

27-
### Option 1: Using GitHub CLI (Default)
26+
### Option 1: Authenticating using GitHub CLI
2827

2928
Install dependencies: the [GitHub CLI, aka "gh"](https://cli.github.com/) and [Go](https://go.dev/):
3029

@@ -40,45 +39,35 @@ git clone https://github.com/ready-to-review/goose.git
4039
cd goose && make run
4140
```
4241

43-
### Option 2: Using a GitHub Token (More Control)
42+
### Option 2: Using a fine-grained access token
4443

45-
If you want more control over which repositories the goose can access, you can use a GitHub personal access token instead:
44+
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:
4645

47-
For maximum security, use a [fine-grained personal access token](https://github.com/settings/personal-access-tokens/new):
46+
- **Pull requests**: Read
47+
- **Metadata**: Read
4848

49-
1. Go to GitHub Settings → Developer settings → Personal access tokens → Fine-grained tokens
50-
2. Create a new token with:
51-
- **Expiration**: Set a short expiration (30-90 days recommended)
52-
- **Repository access**: Select only the specific repositories you want to monitor
53-
- **Permissions**:
54-
- Pull requests: Read
55-
- Metadata: Read
56-
3. Copy the token (starts with `github_pat_`)
57-
58-
If you need broader access, you can use a [classic token](https://github.com/settings/tokens):
59-
- Create with `repo` scope (grants full repository access - use with caution)
60-
61-
#### Using the Token
49+
You can then use the token like so:
6250

6351
```bash
6452
export GITHUB_TOKEN=your_token_here
6553
git clone https://github.com/ready-to-review/goose.git
6654
cd goose && make run
6755
```
6856

69-
When `GITHUB_TOKEN` is set, the goose will use it directly instead of the GitHub CLI, giving you precise control over repository access. Fine-grained tokens are strongly recommended for better security.
57+
We don't yet try to persist fine-grained tokens to disk - PR's welcome!
7058

7159
## Known Issues
7260

7361
- Blocking logic isn't 100% accurate (we're working on it)
7462
- The goose may not stop honking until you review your PRs
7563
- Visual notifications won't work on macOS until we sign the binary
64+
- Linux, BSD, and Windows support is implemented but untested
7665

7766
## Pricing
7867

79-
This tool is part of the [CodeGroove](https://codegroove.dev) developer acceleration platform:
80-
- **Forever free** for open-source repositories
81-
- Low-cost fee TBD for access to private repos (the goose needs to eat)
68+
The Goose is part of the [codeGROOVE](https://codegroove.dev) developer acceleration platform:
69+
- **FREE forever** for open-source repositories
70+
- Low-cost fee TBD for access to private repos (the goose needs to eat!)
8271

8372
## Privacy
8473

@@ -88,6 +77,4 @@ This tool is part of the [CodeGroove](https://codegroove.dev) developer accelera
8877

8978
---
9079

91-
Built with ❤️ by [CodeGroove](https://codegroove.dev/products/)
92-
93-
[Contribute](https://github.com/ready-to-review/goose) (PRs welcome, but the goose will judge you)
80+
Built with ❤️ by [codeGROOVE](https://codegroove.dev/) - PRs welcome!

0 commit comments

Comments
 (0)