alee/rutster
0
0
Fork 0
Code Issues Pull Requests 2 Actions Packages Projects Releases Wiki Activity

docs: QUICKSTART env table + 'make a real phone call' walkthrough + README status update (slice-5 T9)

Browse Source 
QUICKSTART gains a Twilio Media Streams section: env-var table for the four
RUTSTER_TWILIO_* vars, the run-with-twilio-live command, the point-Twilio-
at-rutster webhook/TwiML walkthrough, + the outbound-call curl example. The
/v1/trunk routes' auth-deferral (slice 6) is flagged. A 'what's different
from WebRTC' note explains the architectural reuse -- the reflex stack is
ingress-agnostic (Reflex<TapAudioPipe> + LocalVadReflex REUSED from slice-4).

README's spearhead status is corrected + extended: slices 1-4 are merged to
main (the prior status stalled at '1-3 merged, slice-4 active' -- stale);
4.5 (sim/benchmark, ADR-0010) + step 5 (PSTN via rented transport, ADR-0007)
are the active build targets. ADR-0007 honored: rutster parses zero SIP bytes.

T9 of slice-5.

Signed-off-by: Aaron D. Lee <himself@adlee.work>
This commit is contained in:
A.D.Lee
2026-07-05 03:10:13 -04:00
committed by A.D.Lee
parent d19d772bd0
commit e6891f2cec
2 changed files with 103 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -51,12 +51,14 @@ pip install -r examples/openai_realtime_brain/requirements.txt
OPENAI_API_KEY=sk-... python examples/openai_realtime_brain/openai_realtime_brain.py
```
> **Status:** Slices 1–3 (WebRTC media core, WS tap, OpenAI Realtime brain) are merged to
> `main`. Slice 4 (barge-in / VAD-driven playout kill) is the active build target, in flight
> on the `slice-4-dev-a-reflex` + `slice-4-dev-b-tap` branches. Design:
> [`docs/superpowers/specs/2026-07-01-slice-4-barge-in-design.md`](docs/superpowers/specs/2026-07-01-slice-4-barge-in-design.md).
> Implementation plan:
> [`docs/superpowers/plans/2026-07-01-slice-4-barge-in.md`](docs/superpowers/plans/2026-07-01-slice-4-barge-in.md).
> **Status:** Slices 1–4 (WebRTC media core, WS tap, OpenAI Realtime brain,
> barge-in / VAD-driven playout kill) are merged to `main`. Slice 4½
> (sim/benchmark harness, [ADR-0010](docs/adr/0010-spearhead-benchmark-sim-harness.md))
> + step 5 (PSTN via rented Twilio Media Streams transport,
> [ADR-0007](docs/adr/0007-trunk-rented-transport.md)) are the active build targets,
> in flight on their respective branches. ADR-0007 honored: rutster parses zero
> SIP bytes. See the
> [slice-5 design](docs/superpowers/specs/2026-07-05-slice-5-rented-transport-design.md).
## Documentation
@@ -162,12 +164,15 @@ exactly as integrators did on top of Asterisk.
## Status
Slices 1–3 (WebRTC media core, WS tap, OpenAI Realtime brain) are merged to `main`;
spearhead steps 4–6 remain. The
Slices 1–4 (WebRTC media core, WS tap, OpenAI Realtime brain, barge-in /
VAD-driven playout kill) are merged to `main`; spearhead steps 4½ (sim/benchmark
harness, [ADR-0010](docs/adr/0010-spearhead-benchmark-sim-harness.md)) + 5 (PSTN
via rented transport, [ADR-0007](docs/adr/0007-trunk-rented-transport.md)) + 6
(spend cap) remain. The
[vision revision](docs/superpowers/specs/2026-06-26-vision-revision-design.md)
and ADRs define the architecture; the
[slice-4 design](docs/superpowers/specs/2026-07-01-slice-4-barge-in-design.md)
documents the active build.
[slice-5 design](docs/superpowers/specs/2026-07-05-slice-5-rented-transport-design.md)
documents the active build. ADR-0007 honored: rutster parses zero SIP bytes.
## First proof (the spearhead)