From 0c8ec610b8608db6d7831f22ae1bcb8104129be5 Mon Sep 17 00:00:00 2001 From: Gregory Gauthier Date: Mon, 30 Mar 2026 14:29:16 +0100 Subject: [PATCH] docs(readme): update version to 0.3.5 and improve section headings - Bump version references from 0.3.3 to 0.3.5 in installation scripts - Convert plain text sections to Markdown headings for better readability --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4600f22..a9ce3e6 100644 --- a/README.md +++ b/README.md @@ -19,13 +19,13 @@ Grokkit is a fast Go CLI integrating Grok AI with git workflows and general chat **Bash (Linux/macOS):** ```bash -export VERSION=0.3.3 +export VERSION=0.3.5 curl -fsSL https://repos.gmgauthier.com/gmgauthier/grokkit/releases/download/v${VERSION}/grokkit-install.sh | bash -s -- --verify ``` **PowerShell (Windows):** ```pwsh -$env:VERSION="0.3.3" +$env:VERSION="0.3.5" irm https://repos.gmgauthier.com/gmgauthier/grokkit/releases/download/v$env:VERSION/grokkit-install.ps1 | iex ``` @@ -40,7 +40,7 @@ Both installers feature: **Bash (Linux/macOS):** ```bash -export VERSION=0.3.3 +export VERSION=0.3.5 curl -fsSL https://repos.gmgauthier.com/gmgauthier/grokkit/releases/download/v${VERSION}/grokkit-install.sh -o grokkit-install.sh bash grokkit-install.sh --verify ``` @@ -48,7 +48,7 @@ bash grokkit-install.sh --verify **PowerShell (Windows):** ```pwsh -$env:VERSION="0.3.3" +$env:VERSION="0.3.5" irm https://repos.gmgauthier.com/gmgauthier/grokkit/releases/download/v$env:VERSION/grokkit-install.ps1 -OutFile grokkit-install.ps1 .\grokkit-install.ps1 -Verify ``` @@ -156,20 +156,20 @@ Generate shell completions for faster command entry: ### Examples -# Use different model +#### Use different model `grokkit chat -m grok-beta` -# Debug API issues +#### Debug API issues `grokkit edit main.go "refactor" --debug` -# Verbose logging +#### Verbose logging `grokkit review -v` -## Features +#### Features ### Core Features - ✅ **Structured logging with slog** - JSON logs with request tracing, timing, and context @@ -235,15 +235,15 @@ Grokkit uses the xAI Grok API. Be aware: **Common issues:** -# API key not set +### API key not set Error: XAI_API_KEY environment variable not set → Solution: `export XAI_API_KEY=sk-your-key` -# Request timeout +### Request timeout Error: Request failed: context deadline exceeded → Solution: Increase timeout in `config.toml` or check network -# Permission denied on log file +### Permission denied on log file → Solution: `chmod 644 ~/.config/grokkit/grokkit.log`