From 22b5b28f2115744ccbc1cda9b8fcee41e261ce35 Mon Sep 17 00:00:00 2001
From: Jaikinator <schmieder.jacob@web.de>
Date: Fri, 7 Jul 2023 12:57:31 +0200
Subject: [PATCH] updated Readme

---
 README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 47 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 999dba3..8ffe9d1 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,47 @@
-# transcriptor
\ No newline at end of file
+
+# `AutoTranscript`: Fully Automated Transcription using AI 
+
+`AutoTranscript` is a [PyTorch](https://pytorch.org/) based interface for. To enable fully auomated Transcription using AI models containing speaker diarization models:
+
+- [whisper](https://github.com/openai/whisper): an a general-purpose speech recognition model
+- [payannote-audio](https://github.com/pyannote/pyannote-audio) an open-source toolkit for speaker diarization
+
+Therefore `AutoTranscript` can be used as a Commandline Interface a Webserver or as a Python API.
+
+## Setup: 
+For this Project, Python 3.9 were [PyTorch](https://pytorch.org/) version 1.11.0 
+
+The following command will pull and install the latest commit from this repository, along with its Python dependencies.
+
+    pip install https://github.com/JSchmie/autotranscript.git
+  
+## Example Python usage
+
+```python
+from autotranscript import AutoTranscribe
+
+model = AutoTranscribe()
+
+text = model.transcribe("audio.wav")
+
+print(f"Transcription: \n{text}")
+
+```
+
+## Command-line usage
+
+If you not want to control the optimization using python, you also can use the Command-line:
+
+	autotranscript audio.wav
+
+Run the following to view all available options:
+		
+	autotranscript -h
+
+
+## License 
+
+## Citation
+
+
+