From a5380e0b0701561ecfd482042f7a1a3abd209d8a Mon Sep 17 00:00:00 2001 From: Elliott Chen Date: Mon, 11 Nov 2024 15:28:47 +0800 Subject: [PATCH 1/2] docs: updating wording in readme.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 74c1284c..5bc1aea6 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ 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) From bd0c40d1a4ec8af3b850055d2f2377b9af7ea833 Mon Sep 17 00:00:00 2001 From: Elliott Chen Date: Mon, 11 Nov 2024 15:58:43 +0800 Subject: [PATCH 2/2] docs: adding container otherwise misleading --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5bc1aea6..b2e17a16 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,7 @@ 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 ```