|
1 | 1 | # Ready to Review 🎯 |
2 | 2 |
|
3 | | -**Stop being the blocker. Get notified only when it matters.** |
4 | | - |
5 | | -The smartest PR tracker that knows when you're actually blocking someone - not just when you're assigned. Only alerts when tests pass and your review is truly needed. |
| 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. |
6 | 4 |
|
7 | 5 |  |
8 | 6 |
|
9 | | -📊 **Live PR counter** • 🎯 **Only notifies when YOU'RE the blocker** • ✅ **Waits for tests to pass** • ⚡ **One-click access** |
10 | | - |
11 | | -## The Problem We Solve 🎯 |
12 | | - |
13 | | -- **"Did I forget to review that PR?"** - Never again. See pending reviews at a glance. |
14 | | -- **"Is my PR blocking the team?"** - Instant visibility on blocked PRs with ❗ indicators. |
15 | | -- **"Which PR should I review first?"** - Smart prioritization shows you what matters most. |
16 | | -- **"I hate context switching to check PRs"** - Stay in your flow. Check without leaving your work. |
17 | | - |
18 | 7 | ## Quick Start ⚡ |
19 | 8 |
|
20 | 9 | ```bash |
21 | | -# Install dependencies if you don't have them: |
22 | | -brew install gh go # macOS (or visit https://cli.github.com and https://go.dev) |
| 10 | +# Install dependencies: |
| 11 | +brew install gh go # macOS (or visit https://cli.github.com) |
23 | 12 | gh auth login |
24 | 13 |
|
25 | | -# Install & run Ready to Review: |
26 | | -git clone https://github.com/ready-to-review/pr-menubar.git && cd pr-menubar && make run |
| 14 | +# Install & run: |
| 15 | +git clone https://github.com/ready-to-review/pr-menubar.git |
| 16 | +cd pr-menubar && make run |
27 | 17 | ``` |
28 | 18 |
|
29 | | -That's it! The app appears in your menubar showing your PR count. Click to see all PRs with smart prioritization. |
30 | | - |
31 | | -**Perfect for:** |
32 | | -- ✅ Teams doing 10+ PRs/week |
33 | | -- ✅ Open-source contributors |
34 | | -- ✅ Remote/async teams across timezones |
35 | | -- ✅ Anyone who's ever felt guilty about blocking a PR |
36 | | - |
37 | | -## Why Not Just GitHub Notifications? 🤔 |
| 19 | +The app appears in your menubar showing: `incoming / outgoing` PRs |
38 | 20 |
|
39 | | -GitHub notifications are noisy and overwhelming. Ready to Review is different: |
| 21 | +## Features |
40 | 22 |
|
41 | | -- **Actually Smart**: Only notifies when YOU are the specific blocker - not just because you're assigned |
42 | | -- **Test-Aware**: Waits for tests to pass before alerting you - no more reviewing broken PRs |
43 | | -- **Context-Aware**: Knows when someone explicitly asked for your help vs. automatic assignment |
| 23 | +- **Smart Notifications**: Only alerts when YOU are the blocker (not just assigned) |
| 24 | +- **Sound Effects**: Audio cues for important PR events 🔊 |
| 25 | +- **Test-Aware**: Waits for CI to pass before notifying |
44 | 26 | - **Zero Noise**: No pings for PRs that aren't actually blocked on you |
| 27 | +- **One-Click Access**: Open any PR instantly from the menubar |
45 | 28 |
|
46 | | -## How It Works ✨ |
47 | | - |
48 | | -Ready to Review displays a simple counter in your menubar: `incoming / outgoing` |
49 | | - |
50 | | -- **Incoming** 📥: PRs from teammates waiting for your review |
51 | | -- **Outgoing** 📤: Your PRs waiting on others |
52 | | - |
53 | | -Blocked PRs are marked with ❗. Click any PR to open it in your browser. |
54 | | - |
55 | | -### Auto-Start (macOS) 🌟 |
56 | | - |
57 | | -Click the menubar icon and toggle "Start at Login". Never think about it again! |
58 | | - |
59 | | -## Authentication & Privacy 🔐 |
| 29 | +## Installation |
60 | 30 |
|
61 | | -Ready to Review uses your GitHub CLI token (`gh auth token`) to: |
62 | | -- Fetch your PRs from GitHub |
63 | | -- Authenticate with our API server which intelligently determines when you're actually blocking a PR |
64 | | - |
65 | | -**Your token never gets stored on our servers** - we use it to make GitHub API requests, then forget about it. |
66 | | - |
67 | | -## Installation Options |
68 | | - |
69 | | -**Quick Install** (recommended): |
70 | 31 | ```bash |
71 | | -make run # On macOS: installs to /Applications and launches |
| 32 | +make run # Quick install (macOS: installs to /Applications) |
| 33 | +make install # Traditional install for your OS |
| 34 | +make build # Build only |
72 | 35 | ``` |
73 | 36 |
|
74 | | -**Traditional Install**: |
75 | | -```bash |
76 | | -make install # Installs to the right place for your OS: |
77 | | - # macOS: /Applications/Ready to Review.app |
78 | | - # Linux/BSD: /usr/local/bin/ready-to-review |
79 | | - # Windows: %LOCALAPPDATA%\Programs\ready-to-review |
80 | | -``` |
| 37 | +**Requirements**: GitHub CLI (`gh`) authenticated, Go 1.21+ (for building) |
81 | 38 |
|
82 | | -**Build Only**: |
83 | | -```bash |
84 | | -make build # Build for current platform |
85 | | -make app-bundle # macOS: create .app bundle |
86 | | -``` |
87 | | - |
88 | | -**Requirements**: |
89 | | -- GitHub CLI (`gh`) installed and authenticated |
90 | | -- Go 1.21+ (for building from source) |
91 | | - |
92 | | -## Contributing 🤝 |
| 39 | +## Privacy |
93 | 40 |
|
94 | | -Open-source contributions are welcome! Got an idea? Send a PR and we'll ship it. It's that simple. |
| 41 | +Your GitHub token (from `gh auth token`) is used to fetch PRs and authenticate with our API. We never store it. |
95 | 42 |
|
96 | 43 | --- |
97 | 44 |
|
98 | | -### 🌟 Make Your Team Happier Today |
99 | | - |
100 | | -No more blocked PRs. No more forgotten reviews. Just smooth, efficient collaboration. |
101 | | - |
102 | | -Built with ❤️ by [CodeGroove](https://codegroove.dev/products/) for teams who ship fast. |
| 45 | +Built with ❤️ by [CodeGroove](https://codegroove.dev/products/) • [Contribute](https://github.com/ready-to-review/pr-menubar) |
0 commit comments