更新了自述文档

README.md

@@ -1,2 +1,32 @@
-# YongAnFrame 
-基于[EXILED](https://github.com/ExMod-Team/EXILED)写的框架
+  <h1>YongAnFrame</h1>
+  基于[EXILED](https://github.com/ExMod-Team/EXILED)写的框架，为国内服务器常见的插件需求简化开发
+
+## YongAnFrame是什么类型的插件/框架？
+**YongAnFrame** 是一个集成了命令系统、整合了自定义角色及技能系统、称号系统、提示系统的免费框架，使用 **EXILED** 开发。\
+您可以通过安装该插件并使用该框架开发插件，简化您的开发流程。
+
+## 功能
+- 称号系统，使用MySQL作为数据库存储，可配置动态命令
+- DNT检测提示和BDNT(Bypass DNT)请求，使信息获取符合VSR规则
+- 提示系统，可直接调用显示提示
+- 框架玩家对象，整合大量常用属性(DNT、称号、自定义技能等)
+- 音频API
+
+## TODO List
+
+-[ ] 聊天系统和聊天命令，使用.ac联系管理员，.bc公共聊天，.cc阵营聊天<br>
+-[ ] 玩家经验系统和经验命令，配置文件可调整经验获取倍率
+
+## 为服务端安装框架
+ 如图，下载 **Release下的最新压缩包** 全部解压并合并到**EXILED目录**,如C:\Users\Administrator\Appdata\Roaming\ ，安装后请启动一次服务端，并在EXILED\Config内根据提示调整配置文件.
+ ![image](https://github.com/user-attachments/assets/c6a9934b-5cd1-4905-bb94-ae294a12749c)
+
+
+## 使用YongAnFrame进行开发
+ 如图，在您的项目的Nuget包管理器中，安装最新版的YongAnFrame即可
+![image](https://github.com/user-attachments/assets/afd10f37-eac1-4c4c-958c-2c4f655186e8)
+
+## 联系我们 ##
+QQ:3489728203<br>
+Mail:3489728203@qq.com<br>
+Bug反馈或有疑问欢迎提交issue(请附带错误日志/截图，以及问题的详细描述)