Skip to content

Commit e94ea5f

Browse files
docs: update README with clipboard support and structured git context
1 parent ce7668e commit e94ea5f

1 file changed

Lines changed: 23 additions & 12 deletions

File tree

README.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ A lightweight CLI tool that generates clean, Conventional Commit messages from y
2929

3030
## 📌 TL;DR
3131

32-
gitsloth is a minimal Go CLI that reads your staged Git diff, generates a Conventional Commit message using OpenAI, and asks for confirmation before committing.
32+
gitsloth is a minimal Go CLI that reads your staged Git diff (along with your branch name and status), generates a Conventional Commit message using OpenAI, and asks for confirmation before committing — or copies the message to your clipboard.
3333

3434
---
3535

@@ -49,8 +49,10 @@ It focuses on:
4949
## 🔑 Key Features
5050

5151
* **AI-Generated Commit Messages** – Uses OpenAI to turn diffs into clean Conventional Commits
52+
* **Rich Git Context** – Sends branch name, status, and diff together for more accurate messages
5253
* **Conventional Commits Ready** – Enforces proper format and style automatically
5354
* **Interactive Confirmation** – You always approve before committing
55+
* **Clipboard Support** – Copy the generated message instead of committing directly
5456
* **Zero Dependencies** – Uses only the Go standard library
5557
* **Fast CLI Workflow** – Designed to fit seamlessly into your Git routine
5658

@@ -73,15 +75,22 @@ export OPENAI_API_KEY=your_api_key_here
7375
### Usage
7476

7577
```bash
76-
# Stage your changes
78+
# Stage your changes, then generate a commit message
7779
git add .
78-
79-
# Generate commit message
8080
./gitsloth
8181

82-
# Or let the tool stage everything for you
82+
# Let the tool stage everything for you
8383
./gitsloth -a
84+
85+
# Copy the generated message to clipboard instead of committing
86+
./gitsloth -c
8487
```
88+
89+
| Flag | Shorthand | Description |
90+
|------|-----------|-------------|
91+
| `--all` | `-a` | Stage all changes before generating the commit |
92+
| `--clipboard` | `-c` | Copy the generated message to clipboard instead of committing |
93+
8594
---
8695

8796
## 🧪 Example
@@ -90,19 +99,19 @@ git add .
9099
$ ./gitsloth
91100
⣾ Generating commit message...
92101
```
102+
93103
```bash
94104
Proposed commit message:
95-
feat: add custom spinner and remove external dependencies
96-
105+
feat: add clipboard support and structured git context
97106
Accept and commit? (y/n):
98107
```
99108

100109
---
101110

102111
## 📬 Emailware: Share Your Thoughts
103112

104-
gitsloth is emailware.
105-
If you find it useful or interesting, Id like to hear from you.
113+
gitsloth is [emailware](mailto:francescosacco.github@gmail.com).
114+
If you find it useful or interesting, I'd like to hear from you.
106115

107116
📩 francescosacco.github@gmail.com
108117

@@ -111,14 +120,16 @@ If you find it useful or interesting, I’d like to hear from you.
111120
## 🙏 Support
112121

113122
If you like this project:
123+
114124
* ⭐️ Star the repo
115-
* ☕️ Buy me a coffee
125+
* ☕️ [Buy me a coffee](https://www.buymeacoffee.com/saccofrancesco)
116126
* 💌 Send feedback or ideas
117127

118128
---
119129

120130
📎 You Might Also Like…
121-
* [DeepShot](https://github.com/saccofrancesco/deepshot): Predict NBA games using machine learning and advanced stats.
131+
132+
* [Deepshot](https://github.com/saccofrancesco/deepshot): Predict NBA games using machine learning and advanced stats.
122133
* [Supremebot](https://github.com/saccofrancesco/supremebot): A NiceGUI-powered bot for Supreme drops.
123134

124135
---
@@ -129,4 +140,4 @@ This project is licensed under the [MIT License](https://opensource.org/licenses
129140

130141
---
131142

132-
> GitHub @saccofrancesco
143+
> GitHub [@saccofrancesco](https://github.com/saccofrancesco)

0 commit comments

Comments
 (0)