Skip to content

Commit 6666666

Browse files
committed
docs(readme): streamline features and commit format sections
- Shorten features list and remove breaking change details - Simplify commit message format section Signed-off-by: kovacs <mritd@linux.com>
1 parent 6666666 commit 6666666

1 file changed

Lines changed: 3 additions & 16 deletions

File tree

README.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,11 @@ GitFlow Toolkit is a CLI tool written in Go for standardizing git commit message
66

77
## Features
88

9-
- Interactive commit message creation following Conventional Commits 1.0.0
10-
- **BREAKING CHANGE support** with automatic `!` marker and footer generation
11-
- Optional scope - only type and description are required
12-
- **AI-powered commit message generation** using LLM (OpenRouter, Groq, OpenAI, or local Ollama)
13-
- Automatic `Signed-off-by` generation
9+
- Interactive TUI for commit message creation (Conventional Commits 1.0.0)
10+
- AI-powered commit message generation (OpenRouter, Groq, OpenAI, Ollama)
1411
- Git subcommand integration (`git ci`, `git ps`, `git feat`, etc.)
1512
- Lucky commit hash prefix support
16-
- Adaptive terminal UI with light and dark theme support
13+
- Adaptive terminal UI with light/dark theme
1714

1815
## Requirements
1916

@@ -110,18 +107,8 @@ The tool follows the [Conventional Commits 1.0.0](https://www.conventionalcommit
110107
[optional body]
111108
112109
[optional footer(s)]
113-
114-
Signed-off-by: Name <email>
115110
```
116111

117-
**Required:** `type` and `description`
118-
119-
**Optional:** `scope`, `body`, `footer`
120-
121-
**BREAKING CHANGE:** Add a breaking change description to automatically:
122-
- Add `!` marker after type/scope (e.g., `feat!:` or `feat(api)!:`)
123-
- Add `BREAKING CHANGE: <description>` footer
124-
125112
**Supported types:** `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`, `perf`, `hotfix`, `build`
126113

127114
## Configuration

0 commit comments

Comments
 (0)