Skip to content

Commit 13abb4d

Browse files
committed
readme
1 parent ce1e741 commit 13abb4d

File tree

1 file changed

+22
-35
lines changed

1 file changed

+22
-35
lines changed

README.md

Lines changed: 22 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
<p align="center">
2-
<img src="docs/screenshots/readme/library.png" alt="PrompterOne" width="100%" />
3-
</p>
4-
51
<h1 align="center">PrompterOne</h1>
62

73
<p align="center">
@@ -100,10 +96,12 @@ PrompterOne negotiates the initial language from your browser and remembers your
10096

10197
## The Full Flow
10298

103-
```
104-
Library ───> Editor ───> Learn ───> Teleprompter ───> Go Live
105-
browse & write with rehearse read on camera record &
106-
organize TPS markup at speed with live feed stream live
99+
```mermaid
100+
graph LR
101+
A["Library<br/><sub>browse & organize</sub>"] --> B["Editor<br/><sub>write with TPS markup</sub>"]
102+
B --> C["Learn<br/><sub>rehearse at speed</sub>"]
103+
C --> D["Teleprompter<br/><sub>read on camera</sub>"]
104+
D --> E["Go Live<br/><sub>record & stream</sub>"]
107105
```
108106

109107
Every stage works with the same script. Pacing, emphasis, structure, and metadata you add in the editor show up in rehearsal, in the teleprompter, and in the live session. No re-importing, no copy-paste, no format conversion.
@@ -112,33 +110,22 @@ Every stage works with the same script. Pacing, emphasis, structure, and metadat
112110

113111
PrompterOne is in **active alpha** — usable today for real work, with some areas still expanding.
114112

115-
### Ready
116-
117-
| Feature | What works |
118-
| --- | --- |
119-
| **Library** | Script browsing, folder organization, script creation, workflow launch |
120-
| **Editor** | TPS authoring with structure, formatting, pacing, emphasis, metadata, speed offsets, AI-assisted rewriting helpers, and inline syntax highlighting |
121-
| **Learn** | RSVP rehearsal with ORP focal point, adjustable speed, phrase-aware timing, context rails, loop toggle |
122-
| **Teleprompter** | Browser reader with focal controls, camera background, mirror toggles, TPS formatting parity, block transitions, persisted preferences |
123-
| **Settings** | Camera and microphone setup with live feedback, device sync, output profiles, recording defaults, transport configuration, distribution targets |
124-
| **Local recording** | Browser-side recording of the composed program feed |
125-
| **Localization** | 7 languages with browser negotiation and persisted user override |
126-
127-
### Working, Still Expanding
128-
129-
| Feature | Current state |
130-
| --- | --- |
131-
| **Go Live core** | Browser program feed, source rails, scene controls, runtime telemetry, session bar |
132-
| **VDO.Ninja** | Transport-aware connection and publish from the browser |
133-
| **LiveKit** | Transport-aware connection and publish from the browser |
134-
| **Distribution targets** | Capability-gated routing with honest blocking of unsupported paths |
135-
| **Cloud storage** | Provider-backed snapshot import/export for scripts and settings |
136-
137-
### Intentional Constraints
138-
139-
- PrompterOne does not claim generic browser RTMP fan-out to every platform. Downstream targets work only when the active transport path genuinely supports them.
140-
- The live runtime is stricter than most streaming dashboards — unsupported paths stay blocked instead of being faked.
141-
- There is no PrompterOne backend. Recording, streaming, and media processing are browser-only. If a feature needs server infrastructure, it comes from the chosen third-party transport (LiveKit or VDO.Ninja), not from PrompterOne.
113+
| Feature | Status | Details |
114+
| --- | :---: | --- |
115+
| **Library** || Script browsing, folder organization, script creation, workflow launch |
116+
| **Editor** || TPS authoring with structure, formatting, pacing, emphasis, metadata, speed offsets, AI-assisted rewriting, inline syntax highlighting |
117+
| **Learn** || RSVP rehearsal with ORP focal point, adjustable speed, phrase-aware timing, context rails, loop toggle |
118+
| **Teleprompter** || Focal controls, camera background, mirror toggles, TPS formatting parity, block transitions, persisted preferences |
119+
| **Settings** || Camera and microphone setup with live feedback, device sync, output profiles, recording defaults, transport config, distribution targets |
120+
| **Local recording** || Browser-side recording of the composed program feed |
121+
| **Localization** || 7 languages with browser negotiation and persisted user override |
122+
| **Go Live core** | 🟡 | Browser program feed, source rails, scene controls, runtime telemetry, session bar |
123+
| **VDO.Ninja** | 🟡 | Transport-aware connection and publish from the browser |
124+
| **LiveKit** | 🟡 | Transport-aware connection and publish from the browser |
125+
| **Distribution targets** | 🟡 | Capability-gated routing — unsupported paths are blocked, not faked |
126+
| **Cloud storage** | 🟡 | Provider-backed snapshot import/export for scripts and settings |
127+
| **Generic RTMP fan-out** || Intentionally not supported — downstream targets require a real transport path |
128+
| **PrompterOne backend** || By design — the browser is the only runtime, no server tier |
142129

143130
## Roadmap
144131

0 commit comments

Comments
 (0)