Skip to content

Commit d7905f4

Browse files
committed
feat: refactor README.md formatting and content for clarity and consistency.
1 parent 2c9004e commit d7905f4

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ Save time, stay in flow, and write better commit messages — automatically.
55

66
---
77

8-
## Features
8+
## Features
99

10-
- 🧠 Uses GPT to summarize your staged diffs into clear commit messages
11-
- 🛠️ Supports [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
12-
- 🎭 Tone customization (`neutral`, `casual`, `formal`, `funny`, etc.)
13-
- 🧩 Git hook integration via `prepare-commit-msg`
14-
- ⚙️ Supports environment variables for default `TYPE` and `TONE`
15-
- Optional auto mode to skip confirmation (for non-interactive use)
10+
- Uses GPT to summarize your staged diffs into clear commit messages
11+
- Supports [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
12+
- Tone customization (`neutral`, `casual`, `formal`, `funny`, etc.)
13+
- Git hook integration via `prepare-commit-msg`
14+
- Supports environment variables for default `TYPE` and `TONE`
15+
- Optional auto mode to skip confirmation (for non-interactive use)
1616

1717
---
1818

19-
## 🚀 Quick Start
19+
## Quick Start
2020

2121
### 1. Clone the repo and install dependencies:
2222

@@ -86,7 +86,7 @@ Uninstall the hook:
8686
commit-companion uninstall-hook
8787
```
8888

89-
### 🔁 Optional: Global Installation
89+
### Optional: Global Installation
9090

9191
To use commit-companion from any repo without activating a virtual environment:
9292
#### 1. Install globally:
@@ -115,18 +115,18 @@ commit-companion install-hook
115115
```
116116

117117

118-
## 🧠 Roadmap Ideas
118+
## Roadmap Ideas
119119
- Config file support (.commitcompanion.json)
120120
- VS Code extension
121121
- Web version / hosted API
122122
- PyPI distribution (pip install commit-companion)
123123

124-
## 💡 Why Use This?
124+
## Why Use This?
125125
Writing commit messages breaks flow. Commit Companion helps you:
126126
- Stay focused on your code
127127
- Standardize commits with no effort
128128
- Impress your teammates with clear, consistent commit messages
129129

130-
## 📄 License
130+
## License
131131

132132
MIT License.

0 commit comments

Comments
 (0)