e8c8327631
Each example holds the license's text as LICENSE (wai/LICENSE, byte for byte) and says so in its README; wai create writes it with the rest of the template, from one copy in the binary. Co-Authored-By: Claude Opus 5.5 <[email protected]>
29 lines
2.2 KiB
Markdown
29 lines
2.2 KiB
Markdown
# WAI examples
|
|
|
|
Small projects that each do one thing with WAI, and each run on your own machine with the open
|
|
reference software alone. Every one is a template of `wai create`:
|
|
|
|
```sh
|
|
wai create my-room --template video-room
|
|
cd my-room
|
|
wai dev
|
|
```
|
|
|
|
| Template | What it shows | Runs with |
|
|
|---|---|---|
|
|
| [`video-room`](video-room/README.md) | Your own page with a live room in it: camera, microphone, every object checked against its receipt | `wai dev`, a browser |
|
|
| [`watch-together`](watch-together/README.md) | Everyone in a room watching one file in sync: play, pause and seek at one instant for all | `wai dev`, a browser |
|
|
| [`messaging`](messaging/README.md) | An end-to-end encrypted conversation, and a call placed, rung and answered | `wai dev`, a browser |
|
|
| [`encoder-ingest`](encoder-ingest/README.md) | An SRT encoder's stream published into a room, each group signed at the first hop and checked at the relay and the subscriber | `cargo` |
|
|
| [`package-and-deliver`](package-and-deliver/README.md) | A title packed by policy, its package verified, its standard floor played in a page | `wai-pack`, `wai dev`, a browser |
|
|
| [`verify-receipts`](verify-receipts/README.md) | The receipts beside an object checked offline by the reference implementation (Rust) and by a second one (Python, standard library only) | `wai hello`, `cargo`, `python3` |
|
|
| [`apple-app`](apple-app/README.md) | The native sink in a SwiftUI app, and a recorded playback session replayed through it | Xcode, the `wai-sink-swift` package |
|
|
| [`android-app`](android-app/README.md) | The native sink's Kotlin API, the one an Android app's player session calls | a JDK 17, the `wai-sink-android` project |
|
|
| [`remote-desktop`](remote-desktop/README.md) | One machine's screen shared into a room, with control handed over and every input signed | `wai dev`, `wai-remote-host`, a browser |
|
|
|
|
Every example is Apache-2.0, and carries the license's text as `LICENSE`, which a project
|
|
`wai create` makes from it receives with the rest.
|
|
|
|
Each example's `test/` directory holds the check that it works; it is not part of the project
|
|
`wai create` writes. `bash ../quickstart/test/run-examples.sh portable|browser|apple|android`
|
|
runs them, as `.github/workflows/wai-examples.yml` does.
|