Update simple API docs

fakerybakery · Jan 10, 2025 · 9cfdab4 · 9cfdab4
1 parent a8caaef
commit 9cfdab4
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -41,6 +41,8 @@ from simpletts import tts
 tts("Hello, world!").save("output.wav")
 ```
 
+View the [Simple API docs](https://fakerybakery.github.io/simpletts/simple/) for more information.
+
 ## Python API
 
 **Get started with the XTTS model:**

diff --git a/docs/index.md b/docs/index.md
@@ -28,7 +28,11 @@ Or get the latest version from source:
 pip install git+https://github.com/fakerybakery/simpletts
 ```
 
-## Quick Start
+## Quick Start (Simple API)
+
+The [Simple API](simple.md) provides the easiest way to get started with SimpleTTS. With just a few lines of code, you can generate natural-sounding speech. The Simple API **should not be used in environments that require customization or voice cloning** - it's designed for quick and easy use cases.
+
+## Python API
 
 ```python
 from simpletts.models.xtts import XTTS