Skip to content

Commit 8cc1fe6

Browse files
committed
Add SDK section to TPS specification README
1 parent 1bac5c3 commit 8cc1fe6

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,30 @@ TPS bridges this gap: it is human-readable markdown that any text editor can ope
1616
- **Teleprompter app developers** — engineers who parse and render TPS files in real-time reading applications.
1717
- **Content producers** — video/podcast teams who need structured, reviewable scripts with edit points and timing hints.
1818

19+
## SDK
20+
21+
TPS now includes a `ManagedCode.Tps` SDK workspace for parsing, validation, compilation, and playback.
22+
23+
- **SDK catalog page:** [tps.managed-code.com/sdk](https://tps.managed-code.com/sdk/)
24+
- **TypeScript SDK:** [SDK/ts](https://github.com/managedcode/TPS/tree/main/SDK/ts)
25+
- **JavaScript SDK:** [SDK/js](https://github.com/managedcode/TPS/tree/main/SDK/js)
26+
- **.NET SDK:** [SDK/dotnet](https://github.com/managedcode/TPS/tree/main/SDK/dotnet)
27+
28+
Each active SDK exposes the same core contract:
29+
30+
- **Constants catalog** — TPS keywords, tags, metadata keys, emotions, and diagnostics
31+
- **Validation API** — actionable TPS format diagnostics
32+
- **Parser API** — TPS document model generation
33+
- **Compiler API** — JSON-friendly timed state machine generation
34+
- **Player API** — presentation model resolution at runtime
35+
36+
Additional SDK documentation:
37+
38+
- **Workspace overview:** [SDK/README.md](https://github.com/managedcode/TPS/blob/main/SDK/README.md)
39+
- **TypeScript docs:** [SDK/ts/README.md](https://github.com/managedcode/TPS/blob/main/SDK/ts/README.md)
40+
- **JavaScript docs:** [SDK/js/README.md](https://github.com/managedcode/TPS/blob/main/SDK/js/README.md)
41+
- **.NET docs:** [SDK/dotnet/README.md](https://github.com/managedcode/TPS/blob/main/SDK/dotnet/README.md)
42+
1943
## Design Goals
2044

2145
1. **Markdown-compatible** — a `.tps` file renders reasonably in any markdown viewer.

0 commit comments

Comments
 (0)