Skip to content

Commit 343bb5c

Browse files
committed
Add make build, update README
1 parent 9d75d9c commit 343bb5c

File tree

3 files changed

+27
-52
lines changed

3 files changed

+27
-52
lines changed

Makefile

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@
22
# BEGIN: lint-install .
33
# http://github.com/codeGROOVE-dev/lint-install
44

5-
.PHONY: lint test
5+
.PHONY: lint test build
66
test:
77
go test -race ./...
88

9+
build:
10+
mkdir -p out
11+
go build -o out/prs .
12+
913
lint: _lint
1014

1115
LINT_ARCH := $(shell uname -m)

README.md

Lines changed: 22 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,46 @@
1-
# 🚀 prs
1+
# prs
22

3-
> Only shows PRs waiting on YOU
3+
GitHub PR filtering for people who don't have time for GitHub's nonsense.
44

5-
A fast CLI that filters GitHub PRs to show only what needs your attention. No more digging through dozens of PRs to find the ones that actually need you.
5+
Shows only PRs that are actually waiting on you. That's it.
66

7-
## Quick Start
7+
## Install
88

99
```bash
1010
go install github.com/ready-to-review/prs@latest
11-
prs
1211
```
1312

14-
**Requirements:** Go 1.23+ and GitHub CLI (`gh`) authenticated
13+
Requires Go 1.23+ and `gh` auth.
1514

1615
## Usage
1716

1817
```bash
19-
# Show PRs you're involved with (filters out stale PRs)
20-
prs
21-
22-
# Only PRs waiting for your review
23-
prs --blocked
24-
25-
# Include old/stale PRs
26-
prs --include-stale
27-
28-
# Auto-refresh view
29-
prs --watch
30-
31-
# Get notified when PRs need attention
32-
prs --notify
18+
prs # PRs you're involved with
19+
prs --blocked # Only PRs waiting for you
20+
prs --include-stale # Include ancient PRs
21+
prs --watch # Live updates
3322
```
3423

35-
## What You'll See
36-
37-
### Default View (`prs`)
3824
![Default View](media/default.png)
3925

40-
### Live Focus Mode (`prs --blocked --watch`)
41-
![Watch Blocked View](media/watch_blocked.png)
42-
43-
## Options
26+
![Watch Mode](media/watch_blocked.png)
4427

45-
- `--blocked` - Only PRs blocking on you
46-
- `--include-stale` - Include old PRs (hidden by default)
47-
- `--watch` - Live updates with real-time WebSocket + polling
48-
- `--exclude-orgs` - Comma-separated list of organizations to exclude
49-
- `--verbose` - Show detailed logging
28+
## Flags
5029

51-
### Color Output
52-
53-
Colors are automatically adjusted based on your terminal capabilities. To disable colors entirely:
54-
55-
```bash
56-
NO_COLOR=1 prs
30+
```
31+
--blocked PRs blocking on you
32+
--include-stale Show old garbage too
33+
--watch Real-time updates via WebSocket
34+
--exclude-orgs Skip organizations (comma-separated)
35+
--verbose More noise
5736
```
5837

59-
This respects the [NO_COLOR](https://no-color.org/) standard.
60-
61-
## Status Icons
38+
Colors disabled with `NO_COLOR=1`.
6239

63-
- 🚧 Draft PR
64-
- ✅ Ready to merge
65-
- 👍 Has approval
66-
- 💥 Merge conflict
67-
- ⏰ Stale PR
68-
- ❌ Failing tests
69-
- 📝 Regular PR
40+
## Status
7041

71-
## Why This Tool?
42+
Draft, ready, approved, conflicted, stale, failing, or regular. You'll figure it out.
7243

73-
Stop context switching through GitHub tabs. This tool uses smart filtering to show only PRs that actually need your input - not PRs waiting on CI, other reviewers, or ones you've already reviewed.
44+
## Why
7445

75-
Built fast in Go because your development tools shouldn't slow you down.
46+
Because clicking through GitHub tabs is for people with too much time.

media/default.png

-273 KB
Loading

0 commit comments

Comments
 (0)