From 6196c071883e94c8415b9bdfc9dda1d43bec4dc0 Mon Sep 17 00:00:00 2001
From: taylor <=>
Date: Tue, 15 Oct 2024 11:35:20 +0800
Subject: [PATCH] =?UTF-8?q?update:=20=E5=A2=9E=E5=8A=A0readme=E6=96=87?=
 =?UTF-8?q?=E4=BB=B6=E5=86=85=E5=AE=B9?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md        | 24 +++++++++++++++++++++++-
 base-config.yaml |  6 ++++++
 2 files changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 4e55e62..0513c27 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,25 @@
 # maubot-llmplus
 -------
-maubot plugin: llm plus
\ No newline at end of file
+maubot plugin: llm plus
+
+order:
+- !ai info
+> View the configuration information currently in official use.
+- !ai platform list
+> list platforms.
+- !ai platform current
+> query current platform in use.
+- !ai model list
+> list models on current platform.
+- !ai model current
+> query current model in use.
+- !ai use [model_name]
+> switch model in platform, you can use `!ai model list` command query model list.
+- !ai switch [platform_name]
+> switch platform
+> support platforms:
+> - local_ai#ollama
+> - local_ai#lmstudio
+> - openai
+> - anthropic
+
diff --git a/base-config.yaml b/base-config.yaml
index 0439b4f..0ecf25e 100644
--- a/base-config.yaml
+++ b/base-config.yaml
@@ -1,15 +1,20 @@
+# allow users
 allowed_users: []
 
+# current use platform
 use_platform: local_ai
 
+# bot name
 name: "ai bot"
 
 reply_in_thread: true
 
 enable_multi_user: true
 
+# system prompt
 system_prompt: "response in chinese"
 
+# platform config
 platforms:
   local_ai:
     type: ollama
@@ -36,6 +41,7 @@ platforms:
     max_tokens: 2000
     max_context_messages: 20
 
+# additional prompt
 additional_prompt:
   - role: user
     content: "What model is currently in use?"