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

Commit 8d134bf

Browse files
committed
feat(docs): update README with simplified installation and usage
- Simplify installation instructions to single download step - Remove source installation instructions - Consolidate usage instructions into single code block - Update configuration section to mention API key prompt
1 parent aae317f commit 8d134bf

1 file changed

Lines changed: 18 additions & 87 deletions

File tree

README.md

Lines changed: 18 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -5,75 +5,34 @@ Automatically generate git commit messages using AI. Analyzes your staged change
55
## Features
66

77
- Generates clear, concise commit messages from staged changes
8-
- Follows git commit message best practices
98
- Interactive editing with vim
109
- Secure API key storage
1110
- Simple CLI interface
1211

1312
## Installation
1413

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

17-
1. Download the latest release for your platform from [GitHub Releases](https://github.com/yourusername/auto-commit/releases)
18-
2. Extract and move to a location in your PATH:
19-
20-
macOS:
2117
```bash
22-
# For M1/M2 Macs
23-
sudo mv auto-commit-darwin-arm64 /usr/local/bin/auto-commit
24-
25-
# For Intel Macs
26-
sudo mv auto-commit-darwin-x64 /usr/local/bin/auto-commit
27-
28-
# Make executable
18+
# macOS/Linux
19+
sudo mv auto-commit-* /usr/local/bin/auto-commit
2920
sudo chmod +x /usr/local/bin/auto-commit
30-
```
3121

32-
Linux:
33-
```bash
34-
# Move to a location in your PATH
35-
sudo mv auto-commit-linux-x64 /usr/local/bin/auto-commit
36-
37-
# Make executable
38-
sudo chmod +x /usr/local/bin/auto-commit
22+
# Windows (PowerShell as Admin)
23+
move auto-commit-*.exe C:\Windows\System32\auto-commit.exe
3924
```
4025

41-
Windows:
42-
```powershell
43-
# Move to a directory in your PATH
44-
move auto-commit-windows-x64.exe C:\Windows\System32\auto-commit.exe
45-
```
46-
47-
### Option 2: Install from Source
48-
49-
1. Install [Deno](https://deno.land/#installation)
50-
2. Clone this repository
51-
3. Run the installer:
52-
```sh
53-
deno task install
54-
```
55-
56-
## Set up Git Alias (Optional)
26+
## Usage
5727

5828
```bash
29+
# Optional: Set up git alias
5930
git config --global alias.ac '!auto-commit'
60-
```
6131

62-
## Usage
63-
64-
You can use auto-commit in two ways:
65-
66-
1. As a standalone command:
67-
```sh
68-
git add <files>
69-
auto-commit
70-
```
71-
72-
2. As a git alias (if configured):
73-
```sh
74-
git add <files>
75-
git ac
76-
```
32+
# Use the tool
33+
git add <files>
34+
auto-commit # or 'git ac' if alias configured
35+
```
7736

7837
Example output:
7938
```
@@ -83,63 +42,35 @@ Proposed commit:
8342
│ │
8443
│ - Implement JWT token validation │
8544
│ - Add rate limiting middleware │
86-
│ - Create user session management │
87-
│ │
88-
│ BREAKING: All routes now require Authorization header │
8945
└────────────────────────────────────────────────────────────────────────┘
9046
9147
(a)ccept, (e)dit, (r)eject, (n)ew message?
9248
```
9349

94-
Choose an option:
95-
- (a)ccept: Use the generated message and commit changes
96-
- (e)dit: Open in vim to edit before committing
97-
- (r)eject: Cancel the commit
98-
- (n)ew: Generate a new message
99-
10050
## Configuration
10151

102-
On first run, you'll be prompted to enter your Anthropic API key. This will be stored securely in `~/.config/auto-commit/`.
52+
On first run, you'll be prompted to enter your [Anthropic API key](https://console.anthropic.com/account/keys).
10353

10454
## Development
10555

106-
### Building from Source
107-
10856
```bash
109-
# Clone the repository
110-
git clone https://github.com/yourusername/auto-commit.git
57+
# Install dependencies
58+
git clone https://github.com/sidedwards/auto-commit.git
11159
cd auto-commit
11260

113-
# Build executables
61+
# Build
11462
deno task build
11563

116-
# The executables will be in the dist/ directory:
117-
dist/
118-
auto-commit-darwin-arm64 # M1/M2 Mac
119-
auto-commit-darwin-x64 # Intel Mac
120-
auto-commit-windows-x64.exe # Windows
121-
auto-commit-linux-x64 # Linux
122-
```
123-
124-
### Creating a Release
125-
126-
1. Tag the release:
127-
```bash
64+
# Create release
12865
git tag -a v1.0.0 -m "Release v1.0.0"
12966
git push origin v1.0.0
13067
```
13168

132-
2. GitHub Actions will automatically:
133-
- Build executables for all platforms
134-
- Create a GitHub release
135-
- Upload the executables
136-
13769
## Requirements
13870

139-
- Deno 1.x or higher (for development)
14071
- Git
14172
- Vim
142-
- [Anthropic API key](https://console.anthropic.com/account/keys)
73+
- Anthropic API key
14374

14475
## License
14576

0 commit comments

Comments
 (0)