@jcode.labs/mimir-tts 0.4.2 → 0.4.3

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.
Files changed (2) hide show
  1. package/README.md +13 -37
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,16 +1,11 @@
1
- # Mimir TTS
1
+ # Mimir TTS Package
2
2
 
3
- Plug-and-play text-to-speech for Mimir audio summaries.
3
+ `@jcode.labs/mimir-tts` is the standalone text-to-speech package used by Mimir audio summaries.
4
4
 
5
- `@jcode.labs/mimir-tts` has two explicit paths:
5
+ **Full documentation:** https://github.com/jcode-works/jcode-mimir#readme
6
6
 
7
- - Transformers.js WAV for confidential or air-gapped use. This is the default path and does not
8
- require Python, ffmpeg, Piper, XTTS, or a local server.
9
- - Edge MP3 for the same quality path as the global Voice Forge skill. It uses the external
10
- `edge-tts` CLI, `fr-FR-DeniseNeural`, and `+0%` rate, and must be requested explicitly.
11
-
12
- The Edge path sends the narration text to the online Edge TTS service. Use the Transformers.js path
13
- for private content.
7
+ This npm README is intentionally short because package READMEs are displayed separately on npm. The
8
+ GitHub root README is the canonical product documentation.
14
9
 
15
10
  ## Install
16
11
 
@@ -18,36 +13,17 @@ for private content.
18
13
  pnpm add -D @jcode.labs/mimir-tts
19
14
  ```
20
15
 
21
- Install Edge TTS only when you want the highest-quality online MP3 renderer:
22
-
23
- ```bash
24
- pipx install edge-tts
25
- ```
26
-
27
- ## Render
28
-
29
- High-quality MP3:
30
-
31
- ```bash
32
- pnpm exec mimir-tts render /tmp/MIMIR-SUMMARY-tax.txt \
33
- --engine edge \
34
- --out .mimir/audio/tax-summary.mp3
35
- ```
36
-
37
- Offline/confidential WAV:
16
+ ## Quick Commands
38
17
 
39
18
  ```bash
40
- pnpm exec mimir-tts render summary.txt \
41
- --offline \
42
- --model-path .mimir/models/tts \
43
- --out .mimir/audio/summary.wav
19
+ pnpm exec mimir-tts doctor --json
20
+ pnpm exec mimir-tts render /tmp/summary.txt --offline --out .mimir/audio/summary.wav
21
+ pnpm exec mimir-tts render /tmp/summary.txt --engine edge --out .mimir/audio/summary.mp3
44
22
  ```
45
23
 
46
- ## Doctor
24
+ The default engine is `transformers` for offline/confidential WAV output. Use `--engine edge` only
25
+ when sending narration text to online Edge TTS is acceptable.
47
26
 
48
- ```bash
49
- pnpm exec mimir-tts doctor --json
50
- ```
27
+ ## License
51
28
 
52
- The default engine is `transformers`. The default Transformers.js model is `Xenova/mms-tts-fra`.
53
- Override it with `--model` or `MIMIR_TTS_MODEL`.
29
+ MIT (c) Jean-Baptiste Thery.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jcode.labs/mimir-tts",
3
- "version": "0.4.2",
3
+ "version": "0.4.3",
4
4
  "description": "Plug-and-play Edge-quality and offline text-to-speech for Mimir audio summaries.",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -24,7 +24,7 @@
24
24
  "url": "git+https://github.com/jcode-works/jcode-mimir.git",
25
25
  "directory": "packages/mimir-tts"
26
26
  },
27
- "homepage": "https://github.com/jcode-works/jcode-mimir/tree/main/packages/mimir-tts#readme",
27
+ "homepage": "https://github.com/jcode-works/jcode-mimir#readme",
28
28
  "bugs": {
29
29
  "url": "https://github.com/jcode-works/jcode-mimir/issues"
30
30
  },