Skip to content

Commit f588c35

Browse files
0xkazclaude
andcommitted
📚 Update README and add comprehensive feature documentation
- Update README with new v0.1.0 features (dry-run and summary) - Add detailed examples for new features - Fix installation method to use correct download URL - Add What's New section highlighting latest features - Create FEATURES.md with comprehensive feature documentation - Remove duplicate sections in README 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 2fbfcae commit f588c35

File tree

2 files changed

+166
-12
lines changed

2 files changed

+166
-12
lines changed

README.md

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ claude-auto-commit -l en -e -t feat
3636
- 📝 **Conventional Commits**: Optional support for conventional commit format
3737
- 🔄 **Auto-update**: Automatic updates with rollback capability
3838
- 🎯 **Smart Detection**: Analyzes file types, change patterns, and project context
39+
- 🔍 **Dry Run Mode**: Preview commit messages without making actual commits
40+
- 📋 **Change Summary**: Detailed statistics about your changes (lines added/deleted, file types)
3941
-**Lightweight**: Shell script with minimal dependencies
4042
- 🛠️ **Configurable**: Extensive customization through CLI options and config files
4143

@@ -96,6 +98,15 @@ claude-auto-commit -s -v
9698
# Custom prefix for hotfix
9799
claude-auto-commit -p "[HOTFIX]" -t fix
98100

101+
# Preview message without committing
102+
claude-auto-commit --dry-run
103+
104+
# Show detailed change statistics
105+
claude-auto-commit --summary
106+
107+
# Combine options for detailed preview
108+
claude-auto-commit --dry-run --summary -v
109+
99110
# Update tool
100111
claude-auto-commit --update
101112
```
@@ -109,15 +120,18 @@ curl -fsSL https://claude-auto-commit.0xkaz.com/install.sh | bash
109120

110121
### Method 2: Manual Download
111122
```bash
112-
# Download for your platform
113-
curl -L -o claude-auto-commit https://github.com/0xkaz/claude-auto-commit/releases/latest/download/claude-auto-commit-$(uname -s)-$(uname -m)
123+
# Download the script
124+
curl -L -o claude-auto-commit https://github.com/0xkaz/claude-auto-commit/releases/latest/download/claude-auto-commit.sh
114125
chmod +x claude-auto-commit
115126
sudo mv claude-auto-commit /usr/local/bin/
116127
```
117128

118-
### Method 3: NPX (Node.js users)
129+
### Method 3: Clone and Install
119130
```bash
120-
npx claude-auto-commit@latest
131+
git clone https://github.com/0xkaz/claude-auto-commit.git
132+
cd claude-auto-commit
133+
chmod +x src/claude-auto-commit.sh
134+
sudo ln -s $(pwd)/src/claude-auto-commit.sh /usr/local/bin/claude-auto-commit
121135
```
122136

123137
## ⚙️ Configuration
@@ -141,6 +155,12 @@ git:
141155
auto_push: true
142156
```
143157
158+
## 🚀 What's New in v0.1.0
159+
160+
- **Dry Run Mode**: Preview commit messages without committing using `--dry-run`
161+
- **Change Summary**: Get detailed statistics about your changes with `--summary`
162+
- **Push Confirmation**: Now prompts before pushing (use `-y` to skip)
163+
144164
## 🤝 Contributing
145165

146166
Contributions are welcome! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
@@ -155,14 +175,6 @@ This project is licensed under the MIT License - see the [LICENSE](./LICENSE) fi
155175
- [Conventional Commits](https://conventionalcommits.org) specification
156176
- Open source community for inspiration
157177

158-
## 🤝 Contributing
159-
160-
Contributions are welcome! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
161-
162-
## 📄 License
163-
164-
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
165-
166178
---
167179

168180
**Made with ❤️ for the developer community**

docs/FEATURES.md

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
# Claude Auto-Commit Features
2+
3+
## Core Features
4+
5+
### 🧠 AI-Powered Commit Messages
6+
Claude analyzes your code changes to generate meaningful commit messages that accurately describe what was changed and why.
7+
8+
### 🌍 Multi-Language Support
9+
Currently supports:
10+
- English (en)
11+
- Japanese (ja)
12+
- Chinese (zh)
13+
- Arabic (ar) - Coming soon
14+
- Spanish (es) - Coming soon
15+
- French (fr) - Coming soon
16+
17+
### 📝 Conventional Commits
18+
Support for the [Conventional Commits](https://www.conventionalcommits.org/) specification:
19+
```bash
20+
claude-auto-commit -c -t feat
21+
# Output: feat: add user authentication module
22+
```
23+
24+
### 🔄 Auto-Update
25+
Automatically checks for updates daily and self-updates when a new version is available.
26+
27+
## New Features (v0.1.0)
28+
29+
### 🔍 Dry Run Mode
30+
Preview the generated commit message without actually committing:
31+
```bash
32+
claude-auto-commit --dry-run
33+
```
34+
35+
### 📊 Change Summary
36+
Get detailed statistics about your changes:
37+
```bash
38+
claude-auto-commit --summary
39+
40+
# Output:
41+
# 📋 Detailed change contents:
42+
# 📁 File statistics:
43+
# src/app.js | 45 +++++++++++++++++++++++++++++++++++++--------
44+
# src/utils.js | 12 ++++++------
45+
#
46+
# ➕ 51 lines added
47+
# ➖ 18 lines deleted
48+
#
49+
# 📝 File types:
50+
# .js: 2 files
51+
# .md: 1 file
52+
```
53+
54+
## Configuration Options
55+
56+
### Command Line Flags
57+
58+
| Flag | Description |
59+
|------|-------------|
60+
| `-b, --branch <branch>` | Target branch for push (default: main) |
61+
| `-l, --language <lang>` | Commit message language |
62+
| `-e, --emoji` | Use emoji in commit messages |
63+
| `-n, --no-push` | Don't push after commit |
64+
| `-s, --no-stage` | Manual file staging |
65+
| `-d, --diff-lines <num>` | Max diff lines to analyze |
66+
| `-m, --message <msg>` | Custom commit message |
67+
| `-t, --type <type>` | Commit type (feat/fix/docs/etc) |
68+
| `-v, --verbose` | Verbose output |
69+
| `-c, --conventional` | Use Conventional Commits format |
70+
| `-p, --prefix <prefix>` | Custom prefix (e.g., [WIP]) |
71+
| `-y, --yes` | Skip push confirmation |
72+
| `--dry-run` | Preview without committing |
73+
| `--summary` | Show detailed change statistics |
74+
75+
### Configuration File
76+
77+
Create `~/.claude-auto-commit/config.yml`:
78+
79+
```yaml
80+
auto_update:
81+
enabled: true
82+
frequency: daily # daily/weekly/manual/always
83+
silent: false
84+
85+
defaults:
86+
language: en
87+
branch: main
88+
emoji: false
89+
conventional: false
90+
91+
git:
92+
auto_stage: true
93+
auto_push: true
94+
```
95+
96+
## Usage Examples
97+
98+
### Basic Usage
99+
```bash
100+
# Simple commit with auto-generated message
101+
claude-auto-commit
102+
103+
# Without pushing
104+
claude-auto-commit -n
105+
```
106+
107+
### Advanced Usage
108+
```bash
109+
# Dry run with summary in Japanese
110+
claude-auto-commit --dry-run --summary -l ja
111+
112+
# Conventional commit for a new feature with emoji
113+
claude-auto-commit -c -t feat -e
114+
115+
# Custom prefix with manual staging
116+
claude-auto-commit -p "[HOTFIX]" -s
117+
118+
# Skip all confirmations for automation
119+
claude-auto-commit -y
120+
```
121+
122+
## Workflow Integration
123+
124+
### Git Aliases
125+
Add to your `.gitconfig`:
126+
```ini
127+
[alias]
128+
ac = !claude-auto-commit
129+
acp = !claude-auto-commit -n
130+
acd = !claude-auto-commit --dry-run --summary
131+
```
132+
133+
### Pre-commit Hook
134+
Coming soon: Automatic message generation as a git hook.
135+
136+
## Upcoming Features
137+
138+
- 📝 **Template System**: Save and reuse common commit message patterns
139+
- 🧠 **Learning Mode**: Analyze your commit history to match your style
140+
- ✂️ **Split Commits**: Break large changes into logical commits
141+
- 🔧 **Selective Analysis**: Filter files to include/exclude from analysis
142+
- 🔗 **Git Hook Integration**: Automatic message generation on commit

0 commit comments

Comments
 (0)