@jcode.labs/mimir-tts 0.4.3 → 0.4.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,19 +1,34 @@
|
|
|
1
1
|
# Mimir TTS Package
|
|
2
2
|
|
|
3
3
|
`@jcode.labs/mimir-tts` is the standalone text-to-speech package used by Mimir audio summaries.
|
|
4
|
+
It gives Mimir a plug-and-play narration renderer without making audio generation part of the core
|
|
5
|
+
RAG pipeline.
|
|
4
6
|
|
|
5
7
|
**Full documentation:** https://github.com/jcode-works/jcode-mimir#readme
|
|
6
8
|
|
|
7
9
|
This npm README is intentionally short because package READMEs are displayed separately on npm. The
|
|
8
10
|
GitHub root README is the canonical product documentation.
|
|
9
11
|
|
|
12
|
+
## What It Does
|
|
13
|
+
|
|
14
|
+
The package renders text files into local audio files for briefings, study notes, project summaries,
|
|
15
|
+
or agent-generated narration.
|
|
16
|
+
|
|
17
|
+
It supports two explicit paths:
|
|
18
|
+
|
|
19
|
+
- Transformers.js WAV for offline or confidential content. This is the default path.
|
|
20
|
+
- Edge TTS MP3 for higher-quality online narration when sending the text to Edge TTS is acceptable.
|
|
21
|
+
|
|
22
|
+
It does not require Python, ffmpeg, Piper, XTTS, or a local model server for the default
|
|
23
|
+
Transformers.js path.
|
|
24
|
+
|
|
10
25
|
## Install
|
|
11
26
|
|
|
12
27
|
```bash
|
|
13
28
|
pnpm add -D @jcode.labs/mimir-tts
|
|
14
29
|
```
|
|
15
30
|
|
|
16
|
-
## Quick
|
|
31
|
+
## Quick Start
|
|
17
32
|
|
|
18
33
|
```bash
|
|
19
34
|
pnpm exec mimir-tts doctor --json
|