Skip to content

docs: add Homebrew install path #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vnykmshr merged 2 commits into from
Apr 19, 2026
Merged

docs: add Homebrew install path #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2917291
docs: add Homebrew install path
vnykmshr Apr 19, 2026
74732df
docs(readme): reconnect install-then-run flow in Quick start
vnykmshr Apr 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,22 @@ Built on [`pion/stun`](https://github.com/pion/stun). Pure Go, single static bin

## Quick start

**Homebrew (recommended on macOS):**

```bash
brew tap 1mb-dev/tap
brew install natcheck
```

**Go install (any platform with Go 1.25+):**

```bash
go install github.com/1mb-dev/natcheck/cmd/natcheck@latest
```

Then run:

```bash
natcheck
```

Expand Down