Context
Making the repo public for portfolio presentation. The current README has outdated technical details (SSE transport, requirements.txt, black formatter), internal infrastructure references (game-da-god IP, project board links), an "Under Development" framing, and a dead link to docs/ARCHITECTURE.md. It needs to present the project as a polished, production-quality tool.
Scope
- Rewrite README.md — Professional, employer-facing, no internal details
- Create docs/ARCHITECTURE.md — Lightweight component/data flow overview
- Update LICENSE — Switch to MIT (align with pyproject.toml)
- Scrub internal references — Remove IPs, server names, internal links
Design Principles
- Frame as a general-purpose audio analysis tool (not interview-specific)
- Highlight engineering maturity: 440+ tests, CI matrix, systemd hardening, GPU support
- Show example output (abbreviated JSON) to demonstrate capabilities
- Add CI/Python/License badges
- Keep deployment docs but genericize (no private infra names)
Sub-Issues
Cross-Repo (Same Initiative)
Acceptance Criteria
Context
Making the repo public for portfolio presentation. The current README has outdated technical details (SSE transport, requirements.txt, black formatter), internal infrastructure references (game-da-god IP, project board links), an "Under Development" framing, and a dead link to
docs/ARCHITECTURE.md. It needs to present the project as a polished, production-quality tool.Scope
Design Principles
Sub-Issues
Cross-Repo (Same Initiative)
Acceptance Criteria