From bf4b4ba5f2fe68049ccd81a75b1d47eb76ebd8cf Mon Sep 17 00:00:00 2001
From: retoor <retoor@molodetz.nl>
Date: Sat, 18 Jan 2025 11:01:59 +0000
Subject: [PATCH] docs: add project description, setup prerequisites, and usage
 examples for TTS/STT to README

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2442681
--- /dev/null
+++ b/README.md
@@ -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()
+```