From db96cf522968fbda0105ce40730eeeccb6bc650a Mon Sep 17 00:00:00 2001 From: Greg Gauthier Date: Tue, 3 Mar 2026 22:06:45 +0000 Subject: [PATCH] docs(README): add section for grokkit changelog command Document the new `grokkit changelog` command, including usage examples for generating changelog sections suitable for Gitea release notes. --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 2447ad5..a901290 100644 --- a/README.md +++ b/README.md @@ -157,6 +157,24 @@ Summarize recent git commits. grokkit history # Last 10 commits ``` +### 🗒️ `grokkit changelog` + +Generate a clean `CHANGELOG.md` section from git history, designed specifically so the output can be pasted directly into Gitea release notes. + +```bash +# 1. Create your version tag first +git tag v0.2.0 + +# 2. Generate preview + write (with safety confirmation) +grokkit changelog + +# 3. Output ONLY the new section (perfect for Gitea "Release notes") +grokkit changelog --stdout + +# 4. Write file + get commit reminder +grokkit changelog --commit +``` + ### 📖 `grokkit docs [file...]` Generate language-appropriate documentation comments using Grok AI.