docs: update readme

jrj5423 · Aug 7, 2024 · 76d2b73 · 76d2b73
1 parent 35999cb
commit 76d2b73
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/.env.example b/.env.example
@@ -21,5 +21,5 @@ TIDB_DATABASE=
 # You can get one from https://jina.ai/reranker/
 JINAAI_API_KEY=
 
-# DO NOT CHANGE BELOW CONFIGURATIONS UNLESS YOU KNOW WHAT YOU ARE DOING
+# *** DO NOT CHANGE BELOW CONFIGURATIONS UNLESS YOU KNOW WHAT YOU ARE DOING
 DSP_CACHEBOOL=false
diff --git a/README.md b/README.md
@@ -55,6 +55,8 @@ A conversational search tool based on GraphRAG (Knowledge Graph) that built on t
     - `JINAAI_API_KEY`: get one from [Jina AI](https://jina.ai/reranker/)
     - `TIDB_HOST`, `TIDB_USER`, `TIDB_PASSWORD` and `TIDB_DATABASE`: get them from your [TiDB Serverless cluster](https://tidbcloud.com/)
 
+      - Note: TiDB Serverless will provide a default database name called `test`, if you want to use another database name, you need to create a new database in the TiDB Serverless console.
+
 3. Build docker images:
 
     ```bash