docs: rewrite README to house standard

[yakimoto]

Summary

• Rewrites the README to WAVE's house README standard (badges, links row).
• Adds the two example directories the old README omitted (getting-started, mcp/claude-config), both verified to exist in the repo tree, and documents the root pnpm run basic-stream / pnpm run stream-monitor scripts that are wired in package.json but weren't previously mentioned.
• Removed a link to github.com/orgs/wave-av/discussions — verified via the GitHub API that Discussions is not enabled for this repo (has_discussions: false), so the old link was dead.

Test plan

• Preview renders correctly on GitHub
• Linked example directories exist and match table

---

Note

^{Cursor Bugbot is generating a summary for commit 044f362. Configure here.}

Note

Rewrite README to match house standard with updated links and examples

• Replaces the plain header in README.md with a centered block including badges and links, reorders the examples table, and adds entries for getting-started and mcp/claude-config.
• Adds a section documenting the two root-level npm scripts (basic-stream, stream-monitor).
• Updates the API key URL from wave.online/settings/api-keys to wave.online/developers in both README.md and mcp-server-setup/README.md.
• Updates the footer link to developer.wave.online and removes the 'Discussions' link from the 'Get help' section.

^{Macroscope summarized 065309b.}

[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_7c66b9f8-c2f0-4585-93c9-228702a0a2ef)

[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: 36 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: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: c56e6a23-cad6-4040-973c-8c0e3e0ff4f4

📥 Commits

Reviewing files that changed from the base of the PR and between a5e2253 and 065309b.

📒 Files selected for processing (3)

• CHANGELOG.md
• README.md
• mcp-server-setup/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 065309b

Documentation-only changes to README files and CHANGELOG with no runtime impact. Updates include formatting, badges, URL fixes, and expanded example documentation. The author owns all changed files.

^{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 style (centered header, badges, links row, footer).
• Expand/clarify onboarding: examples table, API key link, and root pnpm scripts.
• Remove dead Discussions link and tighten external links.

Diagram

graph TD
  A["README.md"] --> B["Examples table"] --> C["Example directories"]
  A --> D["Root pnpm scripts"] --> E["basic-stream / stream-monitor"]
  A --> F["Help & external links"]

Loading

High-Level Assessment

The following are alternative approaches to this PR:

1. Automate README standardization (template + CI sync)

• ➕ Keeps house style consistent across repos with less manual drift
• ➕ Makes link/footer updates propagate automatically
• ➖ Adds CI/automation overhead for a simple repo
• ➖ Template constraints can slow down repo-specific tweaks

2. Move detailed onboarding to docs site; keep README minimal

• ➕ Single authoritative place for onboarding and scripts
• ➕ README stays short and less likely to become stale
• ➖ Extra click for first-time users
• ➖ Docs-site changes may require coordination and publishing flow

Recommendation: The PR’s approach (manual rewrite to the house standard with grounded, repo-verifiable claims) is the best fit for a one-off alignment and quick onboarding improvement. If multiple repos need ongoing alignment, consider the template+CI sync approach to reduce future drift.

Files changed (1) +26 / -9

Documentation (1) +26 / -9

README.mdRewrite README to house layout; fix links and expand example/script guidance +26/-9

Rewrite README to house layout; fix links and expand example/script guidance

• Reformats the README with a centered header, badges, and a standardized links row/footer. Updates the examples table to include additional directories and clarifies getting-started steps, including documenting root-level pnpm scripts. Fixes outbound links (API key path, removes dead Discussions link, updates Developers URL).

README.md

[qodo-code-review]

Qodo Fixer

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

[devin-ai-integration]

Devin Review found 1 new potential issue.