Skip to content
This repository was archived by the owner on Feb 10, 2026. It is now read-only.

Commit 203ef0a

Browse files
committed
docs(README): update installation instructions
- Add instructions for installing pre-built binary * Separate steps for macOS (M1/M2 and Intel), Linux, and Windows * Move binary to PATH and make executable - Add instructions for installing from source * Install Deno * Clone repo and install with Deno task - Remove outdated development instructions
1 parent 8d134bf commit 203ef0a

1 file changed

Lines changed: 25 additions & 18 deletions

File tree

README.md

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,40 @@ Automatically generate git commit messages using AI. Analyzes your staged change
1111

1212
## Installation
1313

14+
### Option 1: Pre-built Binary
15+
1416
1. Download the latest release for your platform from [GitHub Releases](https://github.com/sidedwards/auto-commit/releases)
1517
2. Move to a location in your PATH:
1618

1719
```bash
18-
# macOS/Linux
19-
sudo mv auto-commit-* /usr/local/bin/auto-commit
20+
# macOS (M1/M2)
21+
sudo mv auto-commit-darwin-arm64 /usr/local/bin/auto-commit
22+
23+
# macOS (Intel)
24+
sudo mv auto-commit-darwin-x64 /usr/local/bin/auto-commit
25+
26+
# Linux
27+
sudo mv auto-commit-linux-x64 /usr/local/bin/auto-commit
28+
29+
# Make executable (macOS/Linux)
2030
sudo chmod +x /usr/local/bin/auto-commit
2131

2232
# Windows (PowerShell as Admin)
23-
move auto-commit-*.exe C:\Windows\System32\auto-commit.exe
33+
move auto-commit-windows-x64.exe C:\Windows\System32\auto-commit.exe
2434
```
2535

36+
### Option 2: Install from Source
37+
38+
````bash
39+
# Install Deno
40+
curl -fsSL https://deno.land/x/install/install.sh | sh
41+
42+
# Clone and install
43+
git clone https://github.com/sidedwards/auto-commit.git
44+
cd auto-commit
45+
deno task install
46+
````
47+
2648
## Usage
2749

2850
```bash
@@ -51,21 +73,6 @@ Proposed commit:
5173

5274
On first run, you'll be prompted to enter your [Anthropic API key](https://console.anthropic.com/account/keys).
5375

54-
## Development
55-
56-
```bash
57-
# Install dependencies
58-
git clone https://github.com/sidedwards/auto-commit.git
59-
cd auto-commit
60-
61-
# Build
62-
deno task build
63-
64-
# Create release
65-
git tag -a v1.0.0 -m "Release v1.0.0"
66-
git push origin v1.0.0
67-
```
68-
6976
## Requirements
7077

7178
- Git

0 commit comments

Comments
 (0)