From 9cfdab499fb22630af4094177bc8d80dc7da23c4 Mon Sep 17 00:00:00 2001 From: mrfakename Date: Thu, 9 Jan 2025 18:17:33 -0800 Subject: [PATCH] Update simple API docs --- README.md | 2 ++ docs/index.md | 6 +++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c81207a..7498ccc 100644 --- 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 index e3de342..f27c90b 100644 --- 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