PyFlowery/docs/index.md
cswimr cb87400278
Some checks failed
Actions / build (push) Successful in 8s
Actions / lint (push) Failing after 13s
Actions / docs (push) Successful in 23s
(2.0.0) woohoo, first major version bump!
bunch of stuff this update, including a full documentation site (still a WIP)
there is now a cache created whenever an instance of `FloweryAPI` is instantiated, so you don't have to query the api and iterate through the api response to retrieve a single voice anymore!
function names have also been changed with this update, hence the major version bump. `get_tts()`, `get_voices()`, and `get_voice()` have been renamed to `fetch_tts()`, `fetch_voices()`, and `fetch_voice()` respectively. `get_voices()` still exists, but with different functionality (that method retrieves voices from the internal cache instead of querying the flowery api)

!BREAKING
2024-09-18 09:55:25 -04:00

11 lines
418 B
Markdown

# Welcome to PyFlowery
/// admonition | This project is in active development
type: warning
These docs are not complete yet, and there is a lot still to do.
///
**PyFlowery** is a Python API Wrapper for the [Flowery](https://flowery.pw/about) API.
Check out the [usage](getting-started/usage.md) section for further information.
Installation instructions can be found [here](getting-started/installation.md).