From b23d763b1febfcb06845d0454a758c2aae33873a Mon Sep 17 00:00:00 2001
From: sjmyuan <shang.jiaming@163.com>
Date: Wed, 9 Oct 2024 22:28:44 +0800
Subject: [PATCH] update README

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8ae5114..8a2a231 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,26 @@
-# AI Bots
\ No newline at end of file
+# AI Bots
+
+AI Bots is a simple platform that allows you to define your own OpenAI-compatible chatbot and chat with the AI bots.
+
+## Creating a config file
+
+The config file is based on the config file of [Streamlit-Authenticator](https://github.com/mkhorasani/Streamlit-Authenticator?tab=readme-ov-file#3-creating-a-config-file)
+
+You just need to append the bots section to the config file
+
+```yaml
+bots:
+  - id: 1 # bot id
+    api_key: "" # api key
+    base_url: "" # the base url of OpenAI-compatible platform, for example https://dashscope.aliyuncs.com/compatible-mode/v1
+    model: "" # model name
+    name: "" # bot name
+    description: "" # bot description
+    prompt: "" # bot prompt
+```
+
+## Run the application with Docker
+
+```sh
+docker run -d -e CONFIG_FILE=/app/config.yml -v <path to config file>:/app/config.yml -p 8501:8501 sjmyuan/ai-bots:v0.0.5
+```
\ No newline at end of file