Skip to content

doc: improve readme #6

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
boyvinall merged 1 commit into from
Apr 30, 2026
Merged

doc: improve readme #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,15 @@ reaches your git server.

## Installation

> [!NOTE]
> **macOS:** Pre-built binaries from the Homebrew cask and GitHub releases are **not code-signed** yet. :moneybag:
> When you first run `dirtygit`, macOS may refuse to open it or show an “unidentified developer” warning.
>
> Use **System Settings → Privacy & Security** and click **Open Anyway** for `dirtygit`, or right-click the
> binary in Finder and choose **Open** once.
>
> This will not be necessary if you install from source.

### Homebrew

On macOS you can install via [homebrew](https://brew.sh/) as follows:
Expand Down Expand Up @@ -47,14 +56,6 @@ mv dirtygit /usr/local/bin/

On Windows, extract the `.tar.gz` and move `dirtygit.exe` to a directory in your `%PATH%`.

**macOS:** Pre-built binaries from the Homebrew cask and GitHub releases are **not code-signed** yet.
When you first run `dirtygit`, macOS may refuse to open it or show an “unidentified developer” warning.

Use **System Settings → Privacy & Security** and click **Open Anyway** for `dirtygit`, or right-click the
binary in Finder and choose **Open** once.

To avoid that workflow, install from source as mentiomed below.

### Source

Alternatively, if you have a recent [Go](https://go.dev/) toolchain, you can build/install the latest release
Expand Down
Loading