readme update

[metachris]

No description provided.

[claude]

Claude finished @metachris's task in 59s —— View job

---

Code Review Summary

This is a comprehensive and well-structured README rewrite that significantly improves the documentation quality. The changes transform a loosely organized list of features into a professional, easy-to-navigate document.

What's Good:

• Clear two-entry-point structure highlighting CLI and HTTP server
• Well-organized tables for project structure, endpoints, CLI flags, and environment variables
• Proper Quick Start section with copy-paste commands
• Consistent formatting with horizontal rules separating sections
• Updated dev dependency install commands to use @latest instead of pinned versions

Minor Suggestions:

1. The Docker Hub badge was removed (line 5 in the original). This may be intentional if the badge was pointing to the wrong project (mev-boost instead of go-template), but worth confirming.

2. The CLI flags table shows --log-debug description as "Enable debug logging" but the code at cmd/httpserver/main.go:35 says "log debug messages" - minor inconsistency but not a blocker.

3. Consider adding a note that the @latest suffix for dev dependencies means developers will get the newest versions, which could occasionally introduce breaking changes.

Verified:

• All CLI flags in the table match the actual flags in cmd/httpserver/main.go:16-57
• All endpoints documented match the routes in httpserver/server.go:73-81
• Directory structure accurately reflects the codebase

LGTM - this is a quality improvement to the documentation.

---