Skip to content

docs: rewrite README to house standard #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yakimoto wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: rewrite README to house standard #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
044f362
docs: rewrite README to house standard with grounded claims
yakimoto Aug 5, 2026
065309b
fix(docs): align API key URL, tighten runnable-directory claim
yakimoto Aug 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,11 @@ All notable changes to this project are documented here. The format is based on
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Documentation

- **README rewrite** — refreshed the top-level README (example table, prerequisites, root
scripts, footer) and fixed the API-key URL in `mcp-server-setup/README.md`, which still
pointed at the retired `wave.online/settings/api-keys` path instead of
`wave.online/developers`. Also tightened the banner wording so it no longer implies the
README-only `getting-started` and `mcp/claude-config` directories are clone-and-run projects.
35 changes: 26 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,55 @@
# WAVE examples
<div align="center">

Working examples for the WAVE developer platform. Each directory is a standalone project you can clone and run.
# examples

**Working, runnable examples for the WAVE developer platform — the SDK, the ADK, and the MCP server. Each standalone example directory is a project you can clone and run; get-started guides live in the table below.**

![kind](https://img.shields.io/badge/kind-examples-555?style=flat-square) ![domain](https://img.shields.io/badge/domain-developer--tools-0a7?style=flat-square) ![lang](https://img.shields.io/badge/lang-TypeScript-3178c6?style=flat-square) ![visibility](https://img.shields.io/badge/visibility-public-brightgreen?style=flat-square) ![license](https://img.shields.io/badge/license-Apache--2.0-blue?style=flat-square)

[wave.online](https://wave.online) · [Docs](https://docs.wave.online) · [github](https://github.com/wave-av/examples)

</div>

---

## Examples

| Example | Package | Description |
|---------|---------|-------------|
| --- | --- | --- |
| [`sdk-quickstart`](./sdk-quickstart) | [`@wave-av/sdk`](https://github.com/wave-av/sdk) | Create a stream, start it, and fetch viewer analytics |
| [`mcp-server-setup`](./mcp-server-setup) | [`@wave-av/mcp-server`](https://github.com/wave-av/mcp-server) | Configure WAVE tools in Claude, Cursor, or any MCP client |
| [`adk-hello-agent`](./adk-hello-agent) | [`@wave-av/adk`](https://github.com/wave-av/adk) | Build an AI agent that monitors stream quality |
| [`mcp-server-setup`](./mcp-server-setup) | [`@wave-av/mcp-server`](https://github.com/wave-av/mcp-server) | Configure WAVE tools in Claude, Cursor, or any MCP client |
| [`getting-started`](./getting-started) | `@wave-av/sdk` | Walkthrough: your first live stream in under 5 minutes |
| [`mcp/claude-config`](./mcp/claude-config) | `@wave-av/mcp-server` | `.mcp.json` snippet for Claude Code / Cursor / Windsurf |

## Prerequisites

- Node.js 18+
- A WAVE API key ([get one here](https://wave.online/settings/api-keys))
- A WAVE API key ([get one here](https://wave.online/developers))
Comment thread
yakimoto marked this conversation as resolved.
Comment thread
yakimoto marked this conversation as resolved.

## Getting started

```bash
# Clone this repo
git clone https://github.com/wave-av/examples.git
cd examples

# Pick an example
# Pick a runnable example (has its own package.json)
cd sdk-quickstart
pnpm install
pnpm start
```

The repo root also has two npm scripts wired to lighter-weight snippets:

```bash
pnpm run basic-stream # runs sdk/basic-stream/index.ts
pnpm run stream-monitor # runs adk/stream-monitor/index.ts
```
Comment thread
yakimoto marked this conversation as resolved.

## Get help

- [Documentation](https://docs.wave.online)
- [SDK reference](https://github.com/wave-av/sdk)
- [Discussions](https://github.com/orgs/wave-av/discussions)

## License

Expand All @@ -41,4 +58,4 @@ pnpm start
---

<!-- wave-standard-footer -->
<sub><b><a href="https://wave.online">wave.online</a></b> &nbsp;·&nbsp; <a href="https://docs.wave.online">Docs</a> &nbsp;·&nbsp; <a href="https://dev.wave.online">Developers</a> &nbsp;·&nbsp; <a href="https://agents.wave.online">For agents</a></sub>
<sub><b><a href="https://wave.online">wave.online</a></b> &nbsp;·&nbsp; <a href="https://docs.wave.online">Docs</a> &nbsp;·&nbsp; <a href="https://developer.wave.online">Developers</a></sub>
Comment thread
yakimoto marked this conversation as resolved.
Comment thread
yakimoto marked this conversation as resolved.
2 changes: 1 addition & 1 deletion mcp-server-setup/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Configure the WAVE MCP server so your AI coding assistant can manage streams, pr

## 1. Get an API key

Create one at [wave.online/settings/api-keys](https://wave.online/settings/api-keys), or via CLI:
Create one at [wave.online/developers](https://wave.online/developers), or via CLI:

```bash
npx @wave-av/sdk auth login
Expand Down
Loading