From 077ca521a1bd0d3e4dac4dda8b2da5d6fc4c30e4 Mon Sep 17 00:00:00 2001
From: Yucheng-Jiang <51142637+Yucheng-Jiang@users.noreply.github.com>
Date: Sat, 4 Jan 2025 15:12:54 -0800
Subject: [PATCH] Update README.md

update readme to include description of `ENCODER_API_TYPE` which specified which encoder to use in co-storm
---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index bc4e3b3b..c6263c27 100644
--- a/README.md
+++ b/README.md
@@ -234,6 +234,13 @@ AZURE_API_VERSION="your_azure_api_version"
 YDC_API_KEY="your_youcom_api_key"
 ```
 
+for **Co-STORM**, please also add following
+```
+# if use openai encoder
+ENCODER_API_TYPE="openai"
+# or ENCODER_API_TYPE="azure" if use azure openai encoder
+```
+
 ### STORM examples
 
 **To run STORM with `gpt` family models with default configurations:**