Skip to content

Commit 8eacfe8

Browse files
author
PeepSick
committed
docs: update README with new packages and commands
1 parent 70935bb commit 8eacfe8

1 file changed

Lines changed: 26 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,15 +95,35 @@ Audio (WAV)
9595
## Quick Commands
9696

9797
```bash
98-
modelforce doctor # System health check
99-
modelforce pull piper # Install Piper provider
98+
# Quick commands
99+
modelforce quick "Hello" # Quick synthesis
100+
modelforce play "Hello" # Synthesize and play
101+
modelforce wizard # Interactive setup
102+
103+
# Core commands
104+
modelforce doctor # System health check
105+
modelforce pull piper # Install Piper provider
100106
modelforce pull voice/piper/en_US-lessac-medium # Download voice
101-
modelforce synthesize "Hello" # Generate audio
102-
modelforce voices # List installed voices
103-
modelforce benchmark # Performance test
104-
modelforce compare # Compare providers
107+
modelforce synthesize "Hello" # Generate audio
108+
modelforce voices # List installed voices
109+
modelforce benchmark # Performance test
110+
modelforce compare # Compare providers
105111
```
106112

113+
## Packages
114+
115+
| Package | Description |
116+
|---------|-------------|
117+
| `@modelforce/core` | Core types and interfaces |
118+
| `@modelforce/sdk` | Simple API for text-to-speech |
119+
| `@modelforce/server` | REST API server |
120+
| `@modelforce/web` | React Web UI |
121+
| `@modelforce/cli` | Command-line interface |
122+
| `@modelforce/runtime` | Execution engine |
123+
| `@modelforce/provider-piper` | Piper TTS provider |
124+
| `@modelforce/provider-kokoro` | Kokoro TTS provider |
125+
| `@modelforce/provider-xtts` | XTTS TTS provider |
126+
107127
## For Developers
108128

109129
```bash

0 commit comments

Comments
 (0)