Update README.md

README.md

@@ -10,4 +10,63 @@ tags:
 - speech-synthesis
 - Basque
 - piper
----
+---
+
+# Basque TTS: Maider (Piper Version)
+
+This repository contains a [Piper](https://github.com/OHF-Voice/piper1-gpl) compatible version of the **Maider** Basque text-to-speech model. The original model was developed by **HiTZ Basque Center for Language Technology - Aholab Signal Processing Laboratory** (University of the Basque Country UPV/EHU).
+
+This version has been exported/trained specifically for use with the Piper TTS engine, a fast, local neural text-to-speech engine.
+
+## Model Details
+
+- **Language:** Basque (eu)
+- **Speaker:** Maider (Female)
+- **Architecture:** VITS (Optimized for Piper)
+- **Original Credits:** HiTZ Center / Aholab (Project ILENIA)
+- **Format:** Piper (`.onnx` and `.onnx.json` config)
+
+## Training Details
+
+- **Architecture:** VITS
+- **Training Engine:** Piper (PyTorch Lightning)
+- **Iterations:** 22 epochs
+- **Sample Rate:** 22050 Hz
+- **Phonemization:** espeak-ng (Basque)
+
+## Files Included
+* `eu-maider-medium.onnx`: The exported model for fast inference.
+* `eu-maider-medium.onnx.json`: The configuration file (includes phoneme map and synthesis settings).
+* `epoch=22-step=258750.ckpt`: The PyTorch Lightning checkpoint from the 22nd iteration (useful for further training/fine-tuning).
+
+## Usage
+
+### Using Piper CLI
+You can run the model locally using the Piper binary:
+
+```bash
+echo "Kaixo, hau Maider da, Piper motorra erabiliz euskaraz hitz egiten." | \
+  ./piper --model eu-maider-medium.onnx --output_file output.wav
+```
+### Python API
+
+```Python
+from piper.voice import PiperVoice
+
+voice = PiperVoice.load("eu-maider-medium.onnx", "eu-maider-medium.onnx.json")
+with open("output.wav", "wb") as f:
+    voice.synthesize_wav("Gaur egun eguzkitsua dugu.", f)
+```
+
+## Original Model & Data Source
+
+The base model belongs to the Aholab TTS collection. All voices in this collection are based on the VITS architecture proposed by Kim et al. (2021).
+
+    Maider & Antton: Developed by HiTZ with funding from Project ILENIA.
+
+    License: Public Creative Commons Attribution 4.0 (for the voice resource) and Apache License 2.0 (for the code/model).
+
+## Authors & Credits
+
+The original Maider model was created by:
+HiTZ Basque Center for Language Technology - Aholab Signal Processing Laboratory, University of the Basque Country EHU.