From 8df9b92c8e838934e031caba61818bedd982c3fe Mon Sep 17 00:00:00 2001
From: N1ngYu <ning_yu23333@163.com>
Date: Sun, 23 Feb 2025 19:44:47 +0800
Subject: [PATCH] Update 'How to Use.'

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index 96082b8..856d864 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,20 @@
 # SaltBot
 A QQbot Based on Nonebot.
+
+--------
+# How to Use
+> [!CAUTION]  
+> This guide assumes you have basic programming & networking knowledge.
+> This bot will need change some code to run correctly.
+
+
+1. Install [Python3.12](https://www.python.org/downloads/release/python-3129/)
+2. Install [Nonebot](https://nonebot.dev/docs/quick-start)
+3. Download this repo.
+4. Change the script path on /.venv/Lib/site-packages/nonebot_plugin_maimai_helper/__init__.py, line 87, 93, 201, 204 and line 205. (Please ignore my sh!t code, thanks.)
+5. Run `nb run` in the SaltBot folder.
+
+> [!NOTE]  
+> This bot will use MySQL to storge your & others Userid & Token.
+> Make sure your have a MySQL database on your device.
+> You can change IP(/nonebot_plugin_maimai_helper/util/utils.py) if your database isn't on your local device.