Skip to content

Commit 7dc0a5a

Browse files
committed
Improve README
1 parent 1af8699 commit 7dc0a5a

File tree

1 file changed

+33
-71
lines changed

1 file changed

+33
-71
lines changed

README.md

Lines changed: 33 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -15,32 +15,24 @@ The smartest PR tracker that knows when you're actually blocking someone - not j
1515
- **"Which PR should I review first?"** - Smart prioritization shows you what matters most.
1616
- **"I hate context switching to check PRs"** - Stay in your flow. Check without leaving your work.
1717

18-
## Quick Start (2 minutes)
18+
## Quick Start ⚡
1919

20-
**Prerequisites:** Just GitHub CLI (`gh`)
2120
```bash
22-
# Don't have it? Install in seconds:
23-
brew install gh # macOS
24-
# or visit: https://cli.github.com/
25-
26-
# Authenticate once:
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)
2723
gh auth login
28-
```
2924

30-
**Install & Run:**
31-
```bash
32-
git clone https://github.com/turn-systems/pr-menubar.git
33-
cd pr-menubar
34-
make run # That's it! 🎉
25+
# Install & run Ready to Review:
26+
git clone https://github.com/turn-systems/pr-menubar.git && cd pr-menubar && make run
3527
```
3628

29+
That's it! The app appears in your menubar showing your PR count. Click to see all PRs with smart prioritization.
3730

3831
**Perfect for:**
3932
- ✅ Teams doing 10+ PRs/week
4033
- ✅ Open-source contributors
4134
- ✅ Remote/async teams across timezones
4235
- ✅ Anyone who's ever felt guilty about blocking a PR
43-
- ✅ Engineers who value focus time but want to be responsive
4436

4537
## Why Not Just GitHub Notifications? 🤔
4638

@@ -50,7 +42,6 @@ GitHub notifications are noisy and overwhelming. Ready to Review is different:
5042
- **Test-Aware**: Waits for tests to pass before alerting you - no more reviewing broken PRs
5143
- **Context-Aware**: Knows when someone explicitly asked for your help vs. automatic assignment
5244
- **Zero Noise**: No pings for PRs that aren't actually blocked on you
53-
- **Visual Status**: See your PR count without clicking - know at a glance if you're blocking someone
5445

5546
## How It Works ✨
5647

@@ -59,71 +50,48 @@ Ready to Review displays a simple counter in your menubar: `incoming / outgoing`
5950
- **Incoming** 📥: PRs from teammates waiting for your review
6051
- **Outgoing** 📤: Your PRs waiting on others
6152

62-
Click to see all PRs instantly. Blocked ones are marked with ❗ so you know what's urgent. One more click opens any PR in your browser.
53+
Blocked PRs are marked with ❗. Click any PR to open it in your browser.
6354

64-
### Bonus: Auto-Start Magic! 🌟
55+
### Auto-Start (macOS) 🌟
6556

66-
On macOS, right-click the menubar icon and toggle "Launch at Login". Set it once, never think about it again!
57+
Right-click the menubar icon and toggle "Launch at Login". Never think about it again!
6758

68-
## Get Started in 1 minute 🚀
59+
## Authentication & Privacy 🔐
6960

70-
```bash
71-
# Copy, paste, done:
72-
git clone https://github.com/turn-systems/pr-menubar.git && cd pr-menubar && make run
73-
```
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
7464

75-
**What happens next:**
76-
1. ✅ App appears in your menubar
77-
2. ✅ Shows your PR count immediately
78-
3. ✅ Click to see all PRs with smart prioritization
79-
4. ✅ Enable auto-start and never think about it again
65+
**Your token never gets stored on our servers** - we use it for the request, then forget about it.
8066

81-
## Technical Details 🔧
67+
## Installation Options
8268

83-
<details>
84-
<summary>Authentication & Privacy</summary>
85-
86-
Ready to Review uses the GitHub token from `gh auth token` to authenticate with both GitHub and our Ready to Review API server.
87-
88-
**How it works:**
89-
- We grab your existing GitHub CLI token (no extra logins!)
90-
- Use it to fetch your PRs from GitHub
91-
- Also use it to authenticate with our API server which intelligently determines when you're actually blocking a PR (tests passing, explicit requests, etc.)
92-
- **Your token never gets stored on our servers** - we use it for the magic, then forget about it 🤐
93-
94-
</details>
95-
96-
<details>
97-
<summary>Platform-Specific Installation</summary>
98-
99-
**The Traditional Way:**
69+
**Quick Install** (recommended):
10070
```bash
101-
make install # Installs to the right place for your OS
71+
make run # On macOS: installs to /Applications and launches
10272
```
10373

104-
**Platform Magic:**
105-
- **macOS** 🍎: Installs a proper app bundle to `/Applications`
106-
- **Linux/BSD** 🐧: Drops the binary in `/usr/local/bin`
107-
- **Windows** 🪟: Tucks it away in `%LOCALAPPDATA%\Programs\ready-to-review`
108-
109-
**Just Browsing?**
74+
**Traditional Install**:
11075
```bash
111-
# Build without installing
112-
make build
113-
114-
# macOS folks: create a fancy app bundle
115-
make app-bundle
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
11680
```
11781

118-
</details>
119-
120-
<details>
121-
<summary>Requirements</summary>
82+
**Build Only**:
83+
```bash
84+
make build # Build for current platform
85+
make app-bundle # macOS: create .app bundle
86+
```
12287

123-
- Go 1.21+ (only needed for building from source)
88+
**Requirements**:
12489
- GitHub CLI (`gh`) installed and authenticated
90+
- Go 1.21+ (for building from source)
12591

126-
</details>
92+
## Contributing 🤝
93+
94+
Open-source contributions are welcome! Got an idea? Send a PR and we'll ship it. It's that simple.
12795

12896
---
12997

@@ -133,10 +101,4 @@ No more blocked PRs. No more forgotten reviews. Just smooth, efficient collabora
133101

134102
[⬇️ Download Now](https://github.com/turn-systems/pr-menubar/releases) | [📖 Docs](https://github.com/turn-systems/pr-menubar/wiki) | [🐛 Report Issue](https://github.com/turn-systems/pr-menubar/issues)
135103

136-
## Contributing 🤝
137-
138-
Open-source contributions are welcome! Got an idea? Send a PR and we'll ship it. It's that simple.
139-
140-
---
141-
142-
Built with ❤️ by [CodeGroove](https://codegroove.dev/products/) for teams who ship fast.
104+
Built with ❤️ by [CodeGroove](https://codegroove.dev/products/) for teams who ship fast.

0 commit comments

Comments
 (0)