docs: restructure README per README guidelines

[Miyamura80]

Summary

Restructures the README to follow the project's README guidelines (pitch first, progressive disclosure, TLDRs, tables, copy-pasteable commands), adapted for a source-consumed library rather than a CLI product.

What changed

• Pragmatic masthead: kept the existing badges, added a one-line tagline and an inline •-separated nav bar.
• "What is this": a short bullet summary plus the public/auditability positioning statement.
• Status callout: a > [!NOTE] for the 0.1.0, not-published-to-npm status and the "no secrets in this repo" rule.
• Architecture diagram: a new committed docs/architecture.svg plus a matching ASCII diagram. Both are deliberately abstract (two capability domains, standard-module distribution, host runtime) and avoid folder names, subpaths, component lists, and specific build tooling, so they survive routine renames and refactoring.
• Progressive disclosure: Quick start extras, Package entrypoints, Modules, Architecture, and Visual regression tests are behind <details>, each with a one-line TLDR:.
• Reference tables and annotated config: package entrypoints table and an annotated EnvConfig interface (no live secret values).
• Credits and a zero-maintenance contrib.rocks contributors footer.

CLI-only guideline sections that do not apply to this package (install one-liner, --help/doctor, agent quickstart, exit codes, leaderboard, API-key env vars) were dropped.

Notes

• Prose avoids em dashes and contrastive "not just X, but Y" phrasing so it passes the repo's scripts/check-ai-writing.ts CI check.
• The architecture SVG was rendered to PNG and visually verified for layout/clipping before committing.

🤖 Generated with Claude Code

https://claude.ai/code/session_01BSXhDvj3zDtbbqz8XzL7ke

---

Generated by Claude Code

---

Summary by cubic

Restructures the README to follow our guidelines with a pitch‑first layout, progressive disclosure, and copy‑paste commands. Adds a brand‑styled architecture SVG (two‑domain view, host runtime removed), clarifies config scope and the unpublished status for @edison/shared, and removes the duplicate Architecture section and ASCII diagram.

• New Features

  • Masthead adds a one‑line tagline and inline • nav (Architecture link removed).
  • Tight “What is this” with the public/auditability positioning.
  • Status callout: 0.1.0, not published to npm, and “no secrets in this repo”.
  • Progressive disclosure with TLDRs for Quick start, Entrypoints/Modules, and Visual tests.
  • Reference updates: entrypoints table, annotated EnvConfig, peer deps note, and clear config scope.
  • New brand‑styled docs/architecture.svg (simplified to design‑system + client‑services; host‑runtime layer and inbound arrow removed; alt text updated).
  • Credits and a contrib.rocks contributors footer.

• Bug Fixes

  • Formatted README with Prettier to fix the format:check CI failure.
  • Removed repo‑convention notes from Contributing.

^{Written for commit dbe7dbc. Summary will update on new commits.}

[qodo-code-review]

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →