Skip to content

Commit ba86710

Browse files
committed
docs: Update application setup instructions and requirements
- Update application start command using Docker Compose in README.md - Include instructions for replacing API keys and creating a configuration file in README.md
1 parent d19c900 commit ba86710

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -137,13 +137,15 @@ You can also run the application using Docker:
137137
- ./.transcribe.yaml:/app/.transcribe.yaml
138138
```
139139

140-
Run the following command to start the application using Docker Compose:
140+
Run the following command to start the application using Docker Compose:
141141

142-
```bash
143-
docker compose run --rm app
144-
```
142+
```bash
143+
docker compose run --rm transcribe-me
144+
```
145+
146+
This command mounts the `input`, `output`, `archive`, and `.transcribe.yaml` configuration file into the Docker container. See [`compose.example.yaml`](./compose.example.yaml) for an example configuration.
145147

146-
This command mounts the `input`, `output`, `archive`, and `.transcribe.yaml` configuration file into the Docker container. See [`compose.example.yaml`](./compose.example.yaml) for an example configuration.
148+
Make sure to replace `OPENAI_API_KEY` and `ANTHROPIC_API_KEY` with your actual API keys. Also make sure to create the `.transcribe.yaml` configuration file in the same directory as the `docker-compose.yml` file.
147149

148150
## :rocket: How it Works
149151

0 commit comments

Comments
 (0)