From ee11caeaed7612af09b13691251d17ac20d2a19b Mon Sep 17 00:00:00 2001 From: Johnny Huynh <27847622+johnnyhuy@users.noreply.github.com> Date: Fri, 5 Apr 2024 08:37:53 +1100 Subject: [PATCH] Update installation instructions and usage details - 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 --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 72f93b0..605c94e 100644 --- a/README.md +++ b/README.md @@ -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 ```