Update README.md

README.md

@@ -1,57 +1,137 @@
-# Onyx-TTS
+# **Onyx-TTS**
 
-Onyx-TTS is a high-performance, multilingual text-to-speech system developed by 0N Labs. It's built on ONNX Runtime, delivering fast and efficient speech synthesis with minimal resource requirements.
+Onyx-TTS is a high-performance, multilingual text-to-speech system developed by 0N Labs. It's built on **ONNX Runtime**, delivering fast and efficient speech synthesis with minimal resource requirements.
 
-<audio controls><source src="https://0N-Labs.github.io/example-one.wav" type="audio/wav"></audio>
-<audio controls><source src="https://0N-Labs.github.io/example-two.wav>" type="audio/wav"></audio>
+<p float="left">
+  <audio controls><source src="https://0N-Labs.github.io/example-one.wav" type="audio/wav"></audio>
+  <audio controls><source src="https://0N-Labs.github.io/example-two.wav" type="audio/wav"></audio>
+</p>
 
-## Model Details
+---
 
-- **Developed by**: 0N Labs
-- **Model type**: Text-to-Speech
-- **Languages**: Multiple languages supported
-- **License**: Apache 2.0
-- **Model size**: ~300MB (quantized: ~80MB)
+## **Model Details**
 
-## How to Use
+* **Developed by**: 0N Labs
+* **Model type**: Text-to-Speech
+* **Languages**: Multiple languages supported
+* **License**: Apache 2.0
+* **Model size**: \~300MB (quantized: \~80MB)
 
-### Installation
+---
 
-```bash
-pip install onyx-tts
-```
+## **Getting Started**
+
+### **Prerequisites**
+
+* Python 3.8 or higher
+* `pip` (Python package manager)
+
+---
+
+### **Installation**
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/0N-Labs/onyx-tts.git
+   cd onyx-tts
+   ```
+
+2. Create and activate a virtual environment (recommended):
+
+   ```bash
+   python -m venv venv
+   source venv/bin/activate    # On Windows: venv\Scripts\activate
+   ```
 
-### Basic Usage
+3. Install the required dependencies:
+
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+---
+
+### **Downloading the Model**
+
+Download the model files from the [Releases](https://github.com/0N-Labs/onyx-tts/releases) page and place them in your project directory:
+
+* `onyx-v1.0.onnx` (main model)
+* `voices-v1.0.bin` (voice data)
+
+---
+
+### **Basic Usage**
 
 ```python
 import soundfile as sf
 from onyx_tts import OnyxTTS
 
-# Initialize the TTS engine
+# Initialize the TTS engine with the downloaded model files
 onyx = OnyxTTS("onyx-v1.0.onnx", "voices-v1.0.bin")
 
 # Generate speech
 samples, sample_rate = onyx.create(
-    "Hello! This is Onyx TTS by 0N Labs.", 
-    voice="af_sarah", 
-    speed=1.0, 
+    "Hello! This is Onyx TTS by 0N Labs.",
+    voice="af_sarah",           # See available voices in VOICES.md
+    speed=1.0,                  # Adjust speed (0.5–2.0)
     lang="en-us"
 )
 
-# Save to file
+# Save the generated audio
 sf.write("output.wav", samples, sample_rate)
+print("Speech generated successfully!")
 ```
 
-## Available Voices
+---
+
+### **Running the Web Interface**
 
-See the latest voices and languages in the [VOICES.md](VOICES.md) file.
+To launch the demo UI:
 
-## License
+```bash
+python web_interface.py
+```
 
-- Onyx-TTS: MIT
-- Onyx model: Apache 2.0
+Then visit:
+👉 [http://localhost:7860](http://localhost:7860)
 
-## Citation
+---
+
+## **Available Voices**
+
+To list all available voices:
+
+```python
+from onyx_tts import OnyxTTS
+
+onyx = OnyxTTS("onyx-v1.0.onnx", "voices-v1.0.bin")
+print("Available voices:", onyx.get_voices())
+```
+
+See the full list in `VOICES.md`.
+
+---
+
+## **Troubleshooting**
+
+If you run into issues:
+
+1. Ensure all model files are in the correct location
+2. Check that all dependencies are installed
+3. Verify Python version is 3.8 or higher
+4. Visit the [issues page](https://github.com/0N-Labs/onyx-tts/issues) for known bugs and fixes
+
+---
+
+## **License**
+
+* Onyx-TTS: MIT
+* Onyx model: Apache 2.0
+
+---
+
+## **Citation**
 
 ```bibtex
 @software{onyx-tts,
@@ -64,6 +144,3 @@ See the latest voices and languages in the [VOICES.md](VOICES.md) file.
 }
 ```
 
-## Contact
-
-For questions and support, please contact: contact@0nlabs.ai