Skip to content

Commit

Permalink
Updated documentation and readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexjsteffen committed Sep 11, 2024
1 parent dd9471f commit 7afb0a3
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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!

0 comments on commit 7afb0a3

Please sign in to comment.