docs: rewrite README to house standard

[yakimoto]

Summary

• Rewrites the README to WAVE's house README standard (badges, links row, repo-layout table) while preserving the existing accurate scaffold-stage status (verified directly against cmd/wave-certify/main.go: check/submit return errNotImplemented, version prints wave-certify 0.0.0-scaffold).
• Removes the "Protocol Plane framework" link that pointed at github.com/wave-av/wave-foundation — that repo is private, so the link 404s for the public audience this README is for. Replaced with prose description of the plane-layer-4 role, grounded in capabilities.json's planeLayer: 4 and protocol-plane-layer-4 tag.
• No new capabilities or working commands are claimed beyond what main.go actually implements.

Test plan

• go build -o wave-certify ./cmd/wave-certify succeeds
• Preview renders correctly on GitHub

---

---

Note

Low Risk
Documentation-only README edits with no runtime or dependency changes; scaffold status claims align with existing CLI behavior.

Overview
README-only change — reformats the project README to WAVE’s house template (centered header, badge row, link strip, footer) without changing what the tool actually does today.

The Status section is tightened but still matches main.go: check/submit surface wave-certify: battery not yet implemented, and version prints wave-certify 0.0.0-scaffold. It also ties scaffold/alpha messaging to capabilities.json (lifecycle: alpha, version: 0.1.0, planeLayer: 4).

Protocol Plane positioning no longer links to the private wave-foundation repo (404 for public readers); it describes Hardware / plane layer 4 in prose, consistent with planeLayer and protocol-plane-layer-4 in capabilities.json.

Adds a repo layout table (cmd/wave-certify/main.go, threat-model.md, SECRETS.md, capabilities.json), expands planned check battery names in usage text, drops the separate “Links” block, and adds an explicit License section.

^{Reviewed by Cursor Bugbot for commit cd8d38a. Configure here.}

Note

Rewrite README to reflect current alpha/scaffold state of the CLI

Updates README.md to match the current project state. Key changes include: adding a centered header with badges, updating the status section to note that check returns 'not yet implemented' and version reports '0.0.0-scaffold', expanding usage details per-protocol for the check command, adding a repo layout table, and adding an Apache-2.0 license section. Also logs the change in CHANGELOG.md under Unreleased.

^{Macroscope summarized 6cf8a71.}

[cursor]

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: serverGenReqId_1a615ca4-7d46-48c2-9384-a2ca28f52233)

[coderabbitai]

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 35 minutes

Your organization has reached its usage spending cap. Adjust your spending cap in the billing tab.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 42642dee-13a3-408e-897c-ddc40f9b1cd7

📥 Commits

Reviewing files that changed from the base of the PR and between d9be379 and 6cf8a71.

📒 Files selected for processing (2)

• CHANGELOG.md
• README.md

---

_{Comment @coderabbitai help to get the list of available commands.}

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

_{To customize comments, go to the Qodo configuration screen, or learn more in the docs.}

[macroscopeapp]

Approvability

Verdict: Approved 6cf8a71

Documentation-only changes to README.md and CHANGELOG.md with no runtime impact. The author owns both modified files per CODEOWNERS.

^{You can customize Macroscope's approvability policy. Learn more.}

[qodo-code-review]

PR Summary by Qodo

docs: refresh README to WAVE house standard

📝 Documentation 🕐 Less than 10 minutes

AI Description

• Reformat README to WAVE house template (header, badges, link strip, footer).
• Clarify scaffold/alpha status and planned CLI behavior without overstating implementation.
• Remove private/404 framework link; add repo-layout table and explicit License section.

Diagram

graph TD
  R["README.md"] --> M["cmd/wave-certify/main.go"] --> C["capabilities.json"] --> T["threat-model.md"] --> S["SECRETS.md"] --> L["LICENSE"]

Loading

High-Level Assessment

The documentation-only approach is appropriate: the README is standardized while keeping all capability/status statements traceable to repo sources (CLI entrypoint and capabilities.json) and avoiding public-facing links to private repositories.

Files changed (1) +40 / -10

Documentation (1) +40 / -10

README.mdRewrite README to WAVE house format with grounded scaffold status +40/-10

Rewrite README to WAVE house format with grounded scaffold status

• Replaces the existing README with WAVE’s standard layout (centered header, badge row, link strip, footer). Updates the Status/Usage text to explicitly reflect current scaffold behavior (check/submit not implemented; version prints scaffold) and references capabilities metadata; removes a link to a private framework repo and adds repo layout + License sections.

README.md

[qodo-code-review]

Qodo Fixer

No findings are available for this PR yet. Findings appear here once Qodo has reviewed the PR.