更新文档和 gitignore 文件

.gitignore

@@ -1,10 +1,20 @@
-/config/config.json
-**_test.html
-test_**.html
-logs/
+### Code Editor ###
 
+# VSCode
 .vscode/
+*.code-workspace
+.history
+.ionide
+
+# Pycharm
+*.iws
 .idea/
+out/
+
+### Python ###
+
+# Environments
+env/
 venv/
 cache/
 
@@ -14,3 +24,10 @@ __pycache__/
 *$py.class
 *.pyo
 *.pyc
+
+### Customize ###
+
+config/config.json
+**_test.html
+test_**.html
+logs/

README.md

@@ -9,9 +9,7 @@
 
 ## 简介
 
-基于 
-[python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot) 
-的 Paimon BOT
+基于 [python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot) 的 Paimon BOT
 
 ## 需求
 
@@ -47,8 +45,9 @@
 这个项目目前正在扩展，加入更多原神相关娱乐和信息查询功能，敬请期待。
 
 ## Thanks
+
 |                           Nickname                           | Introduce                        |
-|:-----------------------------------------------------:|-------------------|
+| :----------------------------------------------------------: | -------------------------------- |
 | [原神抽卡全机制总结](https://www.bilibili.com/read/cv10468091) | 本项目抽卡模拟器使用的逻辑       |
 |   [西风驿站](https://bbs.mihoyo.com/ys/collection/307224)    | 本项目攻略图图源                 |
 |     [Yunzai-Bot](https://github.com/Le-niao/Yunzai-Bot)      | 本项使用的抽卡图片和前端资源来源 |

jobs/README.md

@@ -2,7 +2,7 @@
 
 ## 说明
 
-改目录存放 BOT 的工作队列呸注册和具体实现
+改目录存放 BOT 的工作队列、注册和具体实现
 
 ## 基础代码
 
@@ -15,7 +15,6 @@ from jobs.base import RunDailyHandler
 from logger import Log
 from manager import listener_jobs_class
 
-
 @listener_jobs_class()
 class JobTest:
 

metadata/README.md

@@ -1,5 +1,5 @@
 # metadata 目录说明
 
 |   FileName   | Introduce     |
-|:------------:|------------|
+| :----------: | ------------- |
 | shortname.py | 记录短名称MAP |

model/README.md

@@ -1,6 +1,5 @@
 # model 目录说明
 
-
 ## apihelpe 模块
 
 用于获取米忽悠BBS的数据写的请求模块
@@ -24,5 +23,5 @@
 ### 感谢
 
 |                          Nickname                          | Contribution         |
-|:----------------------------------------------------------:|--------------|
+| :--------------------------------------------------------: | -------------------- |
 | [Crawler-ghhw](https://github.com/DGP-Studio/Crawler-ghhw) | 本项目参考的爬虫代码 |

resources/README.md

@@ -8,8 +8,8 @@
 原神官方
 
 ## 使用的styles
+
 |                    ProjectName                    | Contribution     |
 |:-------------------------------------------------:|------------------|
 |      [tailwindcss](https://tailwindcss.com/)      | 本项目使用的CSS框架      |
 | [fontawesome](https://fontawesome.dashgame.com/)  | 一套绝佳的图标字体库和CSS框架 |
-

service/README.md

@@ -3,7 +3,7 @@
 ## 文件说明
 
 |  FileName  | Introduce            |
-|:----------:|------------|
+| :--------: | -------------------- |
 |    init    | 服务初始化           |
 |   admin    | 用于机器人管理       |
 |    base    | 基本数据类型         |
@@ -14,4 +14,3 @@
 |  template  | 模板和无头浏览器渲染 |
 |    user    | 用户管理             |
 |    wish    | 抽卡卡池逻辑请求     |
-