Skip to content

Commit

Permalink
docs(README): update installation instructions
Browse files Browse the repository at this point in the history
- 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
  • Loading branch information
sidedwards committed Oct 23, 2024
1 parent 8d134bf commit 203ef0a
Showing 1 changed file with 25 additions and 18 deletions.
43 changes: 25 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,40 @@ Automatically generate git commit messages using AI. Analyzes your staged change

## Installation

### Option 1: Pre-built Binary

1. Download the latest release for your platform from [GitHub Releases](https://github.com/sidedwards/auto-commit/releases)
2. Move to a location in your PATH:

```bash
# macOS/Linux
sudo mv auto-commit-* /usr/local/bin/auto-commit
# macOS (M1/M2)
sudo mv auto-commit-darwin-arm64 /usr/local/bin/auto-commit

# macOS (Intel)
sudo mv auto-commit-darwin-x64 /usr/local/bin/auto-commit

# Linux
sudo mv auto-commit-linux-x64 /usr/local/bin/auto-commit

# Make executable (macOS/Linux)
sudo chmod +x /usr/local/bin/auto-commit

# Windows (PowerShell as Admin)
move auto-commit-*.exe C:\Windows\System32\auto-commit.exe
move auto-commit-windows-x64.exe C:\Windows\System32\auto-commit.exe
```

### Option 2: Install from Source

````bash
# Install Deno
curl -fsSL https://deno.land/x/install/install.sh | sh

# Clone and install
git clone https://github.com/sidedwards/auto-commit.git
cd auto-commit
deno task install
````

## Usage

```bash
Expand Down Expand Up @@ -51,21 +73,6 @@ Proposed commit:

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

## Development

```bash
# Install dependencies
git clone https://github.com/sidedwards/auto-commit.git
cd auto-commit

# Build
deno task build

# Create release
git tag -a v1.0.0 -m "Release v1.0.0"
git push origin v1.0.0
```

## Requirements

- Git
Expand Down

0 comments on commit 203ef0a

Please sign in to comment.