فهرست منبع

minor changes to readme

Kolja Beigel 1 سال پیش
والد
کامیت
67585d9bf9
1فایلهای تغییر یافته به همراه40 افزوده شده و 11 حذف شده
  1. 40 11
      README.md

+ 40 - 11
README.md

@@ -1,23 +1,44 @@
+
 # RealtimeSTT
 
-*Easy to use low latency speech to text library for realtime applications*
+*Easy-to-use, low-latency speech-to-text library for realtime applications*
+
+---
+
+## About the Project
+
+RealtimeSTT listens to the microphone and transcribes voice into text.  
+
+It's ideal for:
+
+- **Voice Assistants**
+- Applications requiring **fast and precise** speech-to-text conversion
 
-## About the project
+### Features
 
-Listens to microphone and transcribes voice into text.
+- **Voice Activity Detection**: Automatically detects when you start and stop speaking.
+- **Wake Word Activation**: Only starts transcription upon hearing a specific wake word.
+- **Realtime Transcription**: Transforms speech to text in real-time.
 
-Provides voice activity detection, wake word activation and lightning-fast speech-to-text transcription. Checks for voice activity with WebRTC first for a quick decision, then double-checks with Silero for better accuracy for reliable detection even amidst ambient noise.
+> **Hint**: *Check out [RealtimeTTS](https://github.com/KoljaB/RealtimeTTS), the output counterpart of this library, for text-to-voice capabilities. Together, they form a powerful realtime audio wrapper around large language models.*
 
-Perfect for voice assistants or applications where solid, fast and precise speech-to-text transformation is important.
+---
 
-> **Hint**: [RealtimeTTS](https://github.com/KoljaB/RealtimeTTS) it the output counterpart of this library that converts text streams into voice output. Together, they form a powerful realtime audio wrapper around large language model outputs.
+## Tech Stack
 
-## Features
+This library uses:
 
-- **Real-time Transcription**: Delivers text as fast as possible (while you speak) using faster_whisper.
-- **Voice Activity Detection**: Automatically starts/stops recording when speech is detected or when speech ends.
-- **Wake Word Activation**: Starts detection only after a specified wake word (or words) was detected.
-- **Event Callbacks**: Customizable callbacks for when recording starts or finishes.
+- **Voice Activity Detection**
+  - [WebRTCVAD](https://github.com/wiseman/py-webrtcvad) for initial voice activity detection.
+  - [SileroVAD](https://github.com/snakers4/silero-vad) for more accurate verification.
+- **Speech-To-Text**
+  - [Faster_Whisper](https://github.com/guillaumekln/faster-whisper) for instant (GPU-accelerated) transcription.
+- **Wake Word Detection**
+  - [Porcupine](https://github.com/Picovoice/porcupine) for wake word detection.
+
+*These components represent the "industry standard" for cutting-edge applications, providing the most modern and effective foundation for building high-end solutions.*
+
+---
 
 ## Installation
 
@@ -51,6 +72,8 @@ If you plan to use RealtimeSTT with GPU support via CUDA, please follow these st
 
 **Note**: To check if your NVIDIA GPU supports CUDA, visit the [official CUDA GPUs list](https://developer.nvidia.com/cuda-gpus).
 
+---
+
 ## Quick Start
 
 Basic usage:
@@ -100,6 +123,8 @@ recorder = AudioToTextRecorder(on_recording_started=my_start_callback,
                                on_recording_finished=my_stop_callback)
 ```
 
+---
+
 ## Testing the Library
 
 The test subdirectory contains a set of scripts to help you evaluate and understand the capabilities of the RealtimeTTS library.
@@ -126,6 +151,8 @@ The test subdirectory contains a set of scripts to help you evaluate and underst
     - **Dependencies**: Run `pip install openai realtimetts`.
     - **Description**: A basic talkbot in 20 lines of code.
 
+---
+
 ## Configuration
 
 ### Initialization Parameters for `AudioToTextRecorder`
@@ -170,6 +197,8 @@ When you initialize the `AudioToTextRecorder` class, you have various options to
 
 - **on_wakeword_timeout**: Callback function to be called when the system goes back to an inactive state after when no speech was detected after wake word activation.
 
+---
+
 ## Contribution
 
 Contributions are always welcome!