zhanj/claude-hud

mirror of https://github.com/jarrodwatts/claude-hud.git synced 2026-05-17 21:18:36 +00:00

Files

History

Jarrod Watts 36b2a09210 docs: add project documentation and improve robustness

- Add ARCHITECTURE.md, FAQ.md, LLM.md documentation
- Add LICENSE (MIT), CODE_OF_CONDUCT.md, PR template
- Add .editorconfig for consistent formatting
- Add check.sh script for validation
- Fix ESLint errors in hud-config.ts and settings-reader.ts
- Various test and component improvements

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

2026-01-03 12:17:50 +11:00

..

docs: add hud config and replay tooling

2026-01-03 10:05:07 +11:00

docs: Add research findings for claude-hud v2 architecture

2026-01-02 23:08:30 +11:00

API.md

feat: add hud event schema v1

2026-01-03 10:23:30 +11:00

ARCHITECTURE.md

docs: add project documentation and improve robustness

2026-01-03 12:17:50 +11:00

CHANGELOG.md

docs: Update CHANGELOG with accurate stats

2026-01-03 08:44:45 +11:00

FAQ.md

docs: add project documentation and improve robustness

2026-01-03 12:17:50 +11:00

LLM.md

docs: add project documentation and improve robustness

2026-01-03 12:17:50 +11:00

README.md

feat: add hud event schema v1

2026-01-03 10:23:30 +11:00

RELEASING.md

ci: add release automation and matrix

2026-01-03 10:25:17 +11:00

THREAT_MODEL.md

docs: add security policy details

2026-01-03 10:25:46 +11:00

README.md

Documentation

Start here for a map of the project docs.

Getting Started

../README.md for install + quickstart
../TROUBLESHOOTING.md for common setup issues
FAQ.md for common questions

Architecture

ARCHITECTURE.md for the data flow and component map
../CLAUDE.md for contributor-focused technical details
adr/ for architecture decisions
API.md for the HUD event contract
THREAT_MODEL.md for local file and event stream risks

Development

../CONTRIBUTING.md for setup, tests, and contribution guidelines
CHANGELOG.md for release notes
RELEASING.md for the release workflow

LLM Helpers

LLM.md for the copy-paste summary block