From 69890d862b108aec23f26ad3f964b34f0c43815c Mon Sep 17 00:00:00 2001
From: BobMaster <32976627+hibobmaster@users.noreply.github.com>
Date: Thu, 20 Apr 2023 10:02:18 +0800
Subject: [PATCH] Updated Home (markdown)
---
Home.md | 22 +++++++++++++++++++++-
1 file changed, 21 insertions(+), 1 deletion(-)
diff --git a/Home.md b/Home.md
index 476ec1d..2250f12 100644
--- a/Home.md
+++ b/Home.md
@@ -1 +1,21 @@
-If you have any questions, feel free to open an issue or join our matrix room:
https://matrix.to/#/#public:matrix.qqs.tw
\ No newline at end of file
+If you have any questions, feel free to open an issue or join our matrix room:
https://matrix.to/#/#public:matrix.qqs.tw
+
+Glossary
+*: required
+| parameter | |
+|---|---|
+| homeserver* | your matrix server address |
+| user_id* | your matrix account name like @xxx.matrix.org |
+| password | account password |
+| device_id* | your device id, like GMIAZSVFF |
+| access_token | account access_token |
+| room_id | if not set bot will work on the rooms it is in |
+| import_keys_path | location of the E2E room keys |
+| import_keys_password | E2E room keys password |
+| bing_api_endpoint | powered by node-chatgpt-api, see https://github.com/hibobmaster/matrix_chatgpt_bot/wiki/Bing-AI |
+| jailbreakEnabled | bring Sydney back and unlimited Bing chat conversaion |
+| bard_token | see https://github.com/hibobmaster/matrix_chatgpt_bot/wiki/Google-Bard |
+| bing_auth_cookie | bing image creator, `_U` cookie from bing.com |
+| markdown_formatted | format the message that bot will send to room if match some markdown symbols |
+
+Use either `access_token` or `login_id+password`(recommended) to login
\ No newline at end of file