diff --git a/README.md b/README.md index ec99c4ea..4694661a 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,6 @@ **2.0 版本如果有问题请第一时间加群反馈!** -有关 3.0 版本的最新情况,请看这里:[Issue #22](https://github.com/zhamao-robot/zhamao-framework/issues/22) - ## 简介 炸毛框架使用 PHP 编写,采用 Swoole 扩展为基础,主要面向 API 服务,聊天机器人(OneBot 兼容的 QQ 机器人对接),包含 Websocket、HTTP 等监听和请求库,用户代码采用模块化处理,使用注解可以方便地编写各类功能。 @@ -53,16 +51,15 @@ public function index() { 自行构建文档:`mkdocs build -d distribute` ## 特点 -- 支持多账号 +- 原生为多账号设计,支持多个机器人负载均衡 - 使用 Swoole 多工作进程机制和协程加持,尽可能简单的情况下提升了性能 - 灵活的注解事件绑定机制 -- 支持下断点调试(Psysh) - 易用的上下文,模块内随处可用 -- 采用模块化编写,可单独拆装功能 -- 常驻内存,全局缓存变量随处使用 +- 采用模块化编写,可自由搭配其他 composer 组件 +- 常驻内存,全局缓存变量随处使用,提供多种缓存方案 - 自带 MySQL、Redis 等数据库连接池等数据库连接方案 -- 自带 HTTP 服务器、WebSocket 服务器可复用,可以构建属于自己的 HTTP API 接口 -- 静态文件服务器 +- 本身为 HTTP 服务器、WebSocket 服务器,可以构建属于自己的 HTTP API 接口 +- 静态文件服务器,可将前端合并到一起 ## 从 v1 升级 炸毛框架 v2 相对 v1 版本改动了不少内容,其中包括框架底层机制、注解事件分发、调试、命名空间等变化,详情可查看上方文档。 @@ -70,7 +67,9 @@ public function index() { 如果旧版框架使用过程中无问题且对新功能暂无需求,可以继续使用 v1 版本,后续也将维护安全类更新和修复致命 bug。 ## 贡献和捐赠 -如果你在使用过程中发现任何问题,可以提交 Issue 或自行 Fork 后修改并提交 Pull Request。目前项目仅一人维护,耗费精力较大,所以非常欢迎对框架的贡献。 +如果你在使用过程中发现任何问题,可以提交 Issue 或自行 Fork 后修改并提交 Pull Request。 + +目前项目仅一人维护,耗费精力较大,所以非常欢迎对框架的贡献。 本项目为作者闲暇时间开发,如果觉得好用,不妨进行捐助~你的捐助会让我更加有动力完善插件,感谢你的支持! @@ -94,4 +93,6 @@ public function index() { **注意**:在你使用 mirai 等 `AGPL-3.0` 协议的机器人软件与框架连接时,使用本框架需要将你编写或修改的部分使用 `AGPL-3.0` 协议重新分发。 +在贡献代码时,请保管好自己的全局配置文件中的敏感信息,请勿将带有个人信息的配置文件上传 GitHub 等网站。 + ![star](https://starchart.cc/zhamao-robot/zhamao-framework.svg)