From 7afb0a31104e050f685c81e79f5d059301d480cc Mon Sep 17 00:00:00 2001 From: Alexander Jonathan Hardy Steffen Date: Wed, 11 Sep 2024 15:07:54 -0400 Subject: [PATCH] Updated documentation and readme. --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f6c5404..e41ba9a 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,19 @@ **Overview** -------- -The ttsrs project provides a command-line tool for generating spoken audio from text files using OpenAI's text-to-speech (TTS) API. It is based on a similar Python script. +The **ttsrs** project provides a command-line tool for generating spoken audio from text files using OpenAI's text-to-speech (TTS) API. It is designed to facilitate the conversion of written text into high-quality spoken audio, making it accessible for various applications such as audiobooks, accessibility tools, and automated announcements. This project is based on a similar Python script but offers enhanced functionality and ease of use through a streamlined command-line interface. + +For more details, visit the [original Python project on GitHub](https://github.com/tom-huntington/unofficial-openai-tts-cli). **Usage** ----- ### Command-Line Arguments -- `input_file`: The path to the input text file. - `--model` (optional): The TTS model to use. Default is `tts-1-hd`. - `--voice` (optional): The voice to use for TTS. Default is `fable`. - `--apikey` (optional): Use an OpenAI api key inline. +- `input_file`: The path to the input text file. **It must inserted after the flags** ### Features @@ -29,4 +31,12 @@ The ttsrs project provides a command-line tool for generating spoken audio from Before using ttsrs, make sure to set the `OPENAI_API_KEY` environment variable with your OpenAI API key. -Enjoy using ttsrs! +### Example + +The completed markdown string for your shell command (API Key is not functional) would look like this: + +```bash +ttsrs --apikey sk-m8xy4xZg7E5VgfRzTg7cY4HlckFJ92eKlH1zpqv5PQKTYUBl --voice alloy --model tts-1 +``` + +Make sure to replace the API key with your actual key before executing the command. Enjoy using ttsrs!