docs(README): update version info, installation details, and project structure
All checks were successful
CI / Test (push) Successful in 31s
CI / Lint (push) Successful in 25s
CI / Build (push) Successful in 19s

- Update Go version to 1.24.2 in badge and requirements
- Change repository URL to repos.gmgauthier.com
- Update example VERSION to 0.1.3
- Revise model alias for "fast"
- Add testing and linting instructions in Development section
- Expand directory structure with new internal packages and files
This commit is contained in:
Greg Gauthier 2026-03-02 18:56:20 +00:00
parent 68df041a09
commit a9127deedd

View File

@ -4,7 +4,7 @@ Grokkit is a fast Go CLI integrating Grok AI with git workflows and general chat
[![Test Coverage](https://img.shields.io/badge/coverage-72%25-brightgreen)]() [![Test Coverage](https://img.shields.io/badge/coverage-72%25-brightgreen)]()
[![Go Version](https://img.shields.io/badge/go-1.24-blue)]() [![Go Version](https://img.shields.io/badge/go-1.24.2-blue)]()
[![License](https://img.shields.io/badge/license-Unlicense-lightgrey)]() [![License](https://img.shields.io/badge/license-Unlicense-lightgrey)]()
## 🚀 Quick Start ## 🚀 Quick Start
@ -14,7 +14,7 @@ Grokkit is a fast Go CLI integrating Grok AI with git workflows and general chat
export XAI_API_KEY=sk-... export XAI_API_KEY=sk-...
# Install from source # Install from source
git clone https://github.com/yourusername/grokkit.git git clone https://repos.gmgauthier.com/gmgauthier/grokkit.git
cd grokkit cd grokkit
make install make install
@ -26,7 +26,7 @@ grokkit --help
### From pre-built release (recommended) ### From pre-built release (recommended)
```bash ```bash
VERSION=1.0.0 # Replace with latest version tag (omit 'v') VERSION=0.1.3 # Replace with latest version tag (omit 'v')
curl -L https://repos.gmgauthier.com/gmgauthier/grokkit/releases/download/v${VERSION}/grokkit-install.sh | VERSION=${VERSION} bash - curl -L https://repos.gmgauthier.com/gmgauthier/grokkit/releases/download/v${VERSION}/grokkit-install.sh | VERSION=${VERSION} bash -
``` ```
Verify: Verify:
@ -209,7 +209,7 @@ log_level = "info" # debug, info, warn, error
[aliases] [aliases]
beta = "grok-beta-2" beta = "grok-beta-2"
fast = "grok-4-mini" fast = "grok-4-1-fast-non-reasoning"
[chat] [chat]
history_file = "~/.config/grokkit/chat_history.json" history_file = "~/.config/grokkit/chat_history.json"
@ -401,13 +401,23 @@ grokkit review -v
## Development ## Development
```bash ```bash
# All tests pass without XAI_API_KEY (unit tests only)
# Run tests # Run tests
make test make test
# Agent-specific tests
make test-agent
# Run tests with coverage report # Run tests with coverage report
make test-cover make test-cover
open build/coverage.html open build/coverage.html
# Linting (matches CI)
make lint
# Install golangci-lint if needed:
# go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
# Run specific tests # Run specific tests
go test -run TestEditCommand ./cmd -v go test -run TestEditCommand ./cmd -v
@ -425,16 +435,20 @@ make clean
``` ```
grokkit/ grokkit/
├── cmd/ # CLI commands (cobra) ├── cmd/ # CLI commands (Cobra)
├── config/ # Configuration management (viper) ├── config/ # Viper configuration
├── docs/ # Documentation
├── internal/ ├── internal/
│ ├── errors/ # Custom error types │ ├── errors/ # Custom error types
│ ├── git/ # Git operations wrapper │ ├── git/ # Git operations
│ ├── grok/ # Grok API client │ ├── grok/ # xAI Grok API client
│ └── logger/ # Structured logging (slog) │ ├── linter/ # Multi-language linting
├── docs/ # Documentation │ ├── logger/ # Structured slog logging
├── .gitea/ # CI/CD workflows │ └── version/ # Build/version info
└── Makefile # Build automation ├── main.go # Application entrypoint
├── go.mod # Dependencies
├── Makefile # Build automation
└── scripts/ # Install scripts
``` ```
## Documentation ## Documentation
@ -453,7 +467,7 @@ Grokkit uses the xAI Grok API. Be aware:
## Requirements ## Requirements
- Go 1.24+ (for building) - Go 1.24.2 (for building)
- Git (for git-related commands) - Git (for git-related commands)
- XAI API key - XAI API key