From bf24885cb1f30b752056b26dd2c8f7ea63060368 Mon Sep 17 00:00:00 2001 From: EC <2340896+cyfyifanchen@users.noreply.github.com> Date: Mon, 11 Nov 2024 17:11:03 +0800 Subject: [PATCH] docs: updating wording in readme.md (#396) * docs: updating wording in readme.md * docs: adding container otherwise misleading --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 74c1284c..b2e17a16 100644 --- a/README.md +++ b/README.md @@ -117,13 +117,13 @@ You will need to uncheck "Use Rosetta for x86_64/amd64 emulation on Apple Silico #### 1. Modify config files In the root of the project, use `cp` command to create `.env` from the [ .env.example ](https://github.com/TEN-framework/ten-agent/blob/main/.env.example). -It will be used to store environment variables for `docker compose` later, and if you change it, you will need to `source .env` again for the changes to take effect. +It will be used to store environment variables for `docker compose` later, and if you change it, you will need to `source .env` again in the container for the changes to take effect. ```bash cp ./.env.example ./.env ``` #### 2. Setup API keys -Open the `.env` file and fill in the `keys`. +Open the `.env` file and fill in the `keys`. We recommend using [ Deepgram ASR ](https://deepgram.com/) and [ FishAudio TTS ](https://fish.audio/) as they are free to sign up for and offer free credits. Of course, you can also use other services, see the list in [.env.example](https://github.com/TEN-framework/ten-agent/blob/main/.env.example). ```bash # Agora App ID # Agora App Certificate(only required if enabled in the Agora Console)