Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 25 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,27 +24,35 @@ Lives in your menubar like a tiny waterfowl of productivity shame, watching your

You can also visit the web-based dashboard at https://dash.ready-to-review.dev/

## macOS Quick Start ⚡ (How to Get Honked At)
## Dependencies

### Option 1: Authenticating using GitHub CLI
* [go](https://go.dev/) 1.23.4 or higher
* [gh](https://cli.github.com/), AKA the GitHub command-line utility

Install dependencies: the [GitHub CLI, aka "gh"](https://cli.github.com/) and [Go](https://go.dev/):
## macOS Quick Start ⚡ (Get Honked At)

Install dependencies:

```bash
brew install gh go
gh auth login
```

Then summon the goose:
Confirm that `gh` is properly authenticated:

```
gh auth status || gh auth login
```

Build & run:

```bash
git clone https://github.com/ready-to-review/goose.git
cd goose && make run
```

`make run` will cause the goose to implant itself into `/Applications/Review Goose.app` for future use. To be persistently annoyed by the goose every time you start your computer, click the `Start at Login` menu item.
This will will cause the goose to implant itself into `/Applications/Review Goose.app` for future invocations. To be persistently annoyed every time you login, click the `Start at Login` menu item.

### Option 2: Using a fine-grained access token
### Using a fine-grained access token

If you want more control over which repositories the goose can access, you can use a [fine-grained personal access token](https://github.com/settings/personal-access-tokens/new) with the following permissions:

Expand All @@ -54,32 +62,31 @@ If you want more control over which repositories the goose can access, you can u
You can then use the token like so:

```bash
export GITHUB_TOKEN=your_token_here
git clone https://github.com/ready-to-review/goose.git
cd goose && make run
env GITHUB_TOKEN=your_token_here goose
```

We don't yet try to persist fine-grained tokens to disk - PR's welcome!
We don't yet persist fine-grained tokens to disk - PR's welcome!

## Known Issues

- Blocking logic isn't 100% accurate - issues welcome!
- Visual notifications won't work on macOS until we release signed binaries.
- Blocking turn logic isn't 100% accurate - open an issue if you find something.
- The goose may not stop honking until you review your PRs
- Visual notifications won't work on macOS until we sign the binary
- Linux, BSD, and Windows support is implemented but untested

## Pricing

- Review Goose is free forever for usage with public repositories.
- We will soon begin charging a nominal fee ($2.56/mo) for access to private repos (the goose has to eat)
- Review Goose is free forever for public repositories ❤️
- Private repo access will soon be a supporter-only feature to ensure the goose is fed. ($2.56/mo is our recommendation)

## Privacy

- Your GitHub token is used to authenticate against GitHub and codeGROOVE's API for state-machine & natural-language processing
- Your GitHub token is never stored or logged,
- PR metadata may be locally or remotely cached for up to 20 days (performance)
- Your GitHub token is never stored or logged.
- PR metadata may be cached locally & remotely for up to 20 days
- No data is resold to anyone. We don't even want it.
- No telemetry is collected

---

Built with ❤️ by [codeGROOVE](https://codegroove.dev/) - PRs welcome!
Built with 🪿 by [codeGROOVE](https://codegroove.dev/) - PRs welcome!
Binary file modified media/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading