From 5d3fba02e88e30050b95286099a31951a70e6334 Mon Sep 17 00:00:00 2001
From: neurlang <77860779+neurlang@users.noreply.github.com>
Date: Mon, 30 Sep 2024 00:14:01 +0200
Subject: [PATCH] push readme

---
 README.md | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c1c58ca..5b22585 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,16 @@
-# pygoruut
\ No newline at end of file
+# pygoruut
+
+## Getting started
+
+```
+from pygoruut.pygoruut import Pygoruut
+
+pygoruut = Pygoruut()
+
+print(pygoruut.phonemize(language="English", sentence="hello world"))
+
+# Prints:
+# PhonemeResponse(
+#     Words=[Word(CleanWord='hello', Linguistic='hello', Phonetic='hɛloʊ'),
+#            Word(CleanWord='world', Linguistic='world', Phonetic='wɚld')])
+```