docs: add project description, setup prerequisites, and usage examples for TTS/STT to README

Browse Source
This commit is contained in:
retoor 2025-01-18 11:01:59 +00:00
parent 9cfa51ee80
commit bf4b4ba5f2
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# RSPEECH
Speech recognitzion and text-to-speech powered by google.
You need gcloud sdk configured on your PC. Also you need a google project with a billing account. The google project requires a default service account and a service account key. You can also use a service account token.
## TTS
```
from rspeech.tts import tts
await tts("hello world")
```
## STT
```
from rspeech.stt import listen, listen_async
# Async:
text = await listen_async()
# Traditional:
text = listen()
```