Skip to content

Commit 160708a

Browse files
committed
minor rebranding as 'goose'
1 parent af3d67d commit 160708a

File tree

3 files changed

+42
-29
lines changed

3 files changed

+42
-29
lines changed

README.md

Lines changed: 41 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,61 @@
1-
# Ready to Review 🎯
1+
# Ready-to-Review Goose 🪿
22

3-
The smart PR tracker that knows when you're actually blocking someone. Lives in your menubar, tracks GitHub PRs, and plays sound effects when you need to pay attention.
3+
![Experimental](https://img.shields.io/badge/status-experimental-orange)
4+
![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20BSD%20%7C%20Windows-blue)
5+
![Goose Noises](https://img.shields.io/badge/goose%20noises-100%25%20more-green)
6+
[![GitHub](https://img.shields.io/github/stars/ready-to-review/goose?style=social)](https://github.com/ready-to-review/goose)
7+
8+
The only PR tracker that honks at you when you're the bottleneck. Now shipping with 100% more goose noises!
9+
10+
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.
11+
12+
> ⚠️ **EXPERIMENTAL**: This is very much a work in progress. The blocking logic has bugs. It theoretically runs on Linux, BSD, and Windows but we've literally never tested it there. Here be dragons (and geese).
413
514
![PR Menubar Screenshot](media/screenshot.png)
615

7-
## Quick Start ⚡
16+
## What It Does
817

9-
```bash
10-
# Install dependencies:
11-
brew install gh go # macOS (or visit https://cli.github.com)
12-
gh auth login
18+
- **🪿 Honks** when you're blocking someone's PR (authentic goose noises included)
19+
- **🚀 Rocket sounds** when own your own PR is ready to go to 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)
1322

14-
# Install & run:
15-
git clone https://github.com/ready-to-review/pr-menubar.git
16-
cd pr-menubar && make run
17-
```
23+
You can also visit the web-based equivalent at https://dash.ready-to-review.dev/
1824

19-
The app appears in your menubar showing: 🪿 (incoming blocked on you) or 🎉 (outgoing blocked)
25+
## macOS Quick Start ⚡ (How to Get Honked At)
2026

21-
## Features
27+
Install dependencies: the [GitHub CLI, aka "gh"](https://cli.github.com/) and [Go](https://go.dev/):
2228

23-
- **Smart Notifications**: Desktop alerts + sounds when PRs become blocked (🪿 honk for incoming, 🚀 rocket for outgoing)
24-
- **Comprehensive Coverage**: Tracks PRs you're involved in + PRs in your repos needing reviewers
25-
- **Detailed Tooltips**: Hover to see why you're blocking and what's needed
26-
- **Test-Aware**: Waits for CI to pass before notifying
27-
- **Zero Noise**: No pings for PRs that aren't actually blocked on you
28-
- **One-Click Access**: Open any PR instantly from the menubar
29-
- **Multi-User Support**: Track PRs for different GitHub accounts with `--user`
30-
- **Auto-Start**: macOS "Start at Login" option (when running from /Applications)
29+
```bash
30+
brew install gh go
31+
gh auth login
32+
```
3133

32-
## Installation
34+
Then summon the goose:
3335

3436
```bash
35-
make run # Quick install (macOS: installs to /Applications)
36-
make install # Traditional install for your OS
37-
make build # Build only
37+
git clone https://github.com/ready-to-review/goose.git
38+
cd goose && make run
3839
```
3940

40-
**Requirements**: GitHub CLI (`gh`) authenticated, Go 1.23+ (for building)
41+
## Known Issues
42+
43+
- Blocking logic is a WIP (we're working on it)
44+
- Linux/BSD/Windows support is theoretical at best
45+
- The goose may not stop honking until you review your PRs
46+
47+
## Pricing
48+
49+
This tool is part of the [CodeGroove](https://codegroove.dev) developer acceleration platform:
50+
- **Forever free** for open-source repositories
51+
- Low-cost fee TBD for access to private repos (the goose needs to eat)
4152

4253
## Privacy
4354

44-
Your GitHub token (from `gh auth token`) is used to fetch PRs and authenticate with our API. We never store it.
55+
Your GitHub token used to fetch PR metadata but we never store it anywhere. GitHub data is retained strictly for caching purposes with a 20-day maximum TTL.
4556

4657
---
4758

48-
Built with ❤️ by [CodeGroove](https://codegroove.dev/products/)[Contribute](https://github.com/ready-to-review/pr-menubar)
59+
Built with ❤️ and mild sleep deprivation by [CodeGroove](https://codegroove.dev/products/)
60+
61+
[Contribute](https://github.com/ready-to-review/goose) (PRs welcome, but the goose will judge you)

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module github.com/ready-to-review/pr-menubar
1+
module github.com/ready-to-review/goose
22

33
go 1.23.4
44

media/screenshot.png

-19.8 KB
Loading

0 commit comments

Comments
 (0)