Skip to content

Commit

Permalink
Update installation instructions and usage details
Browse files Browse the repository at this point in the history
- Update README.md with clearer instructions and additional installation step
- Include CLI tool installation option
- Update Usage section with new command for running the application
  • Loading branch information
johnnyhuy committed Apr 4, 2024
1 parent 0c97b72 commit ee11cae
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,27 @@ Transcribe Me is a CLI-driven Python application that transcribes audio files us
make install
```

4. Run the `transcribe-me install` command to create the `.transcribe.yaml` configuration file and provide your API keys for OpenAI and Anthropic:
3. Run the `transcribe-me install` command to create the `.transcribe.yaml` configuration file and provide your API keys for OpenAI and Anthropic:

```bash
make transcribe-install
```

4. (Optional) Install the application as a command-line interface (CLI) tool:

```bash
make install-cli
```

## Usage

1. Place your audio files in the `input` directory (or any other directory specified in the configuration).
2. Run the application:

```bash
transcribe-me
```

```bash
make transcribe
```
Expand Down

0 comments on commit ee11cae

Please sign in to comment.