ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2024-11-24 09:05:04 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
e68ce8b3a9
nonebot2/README.md

40 lines
2.6 KiB
Markdown
Raw Normal View History

update README.md
2020-08-11 17:02:29 +08:00
<div align=center>
<img src="docs/.vuepress/public/logo.png" width="200" height="200">
Add docs skeleton
2018-08-14 00:46:45 +08:00
# NoneBot
Update README
2018-07-01 20:37:48 +08:00
Rename package to "nonebot"
2018-12-27 20:23:45 +08:00
[![License](https://img.shields.io/github/license/richardchien/nonebot.svg)](LICENSE)
[![PyPI](https://img.shields.io/pypi/v/nonebot.svg)](https://pypi.python.org/pypi/nonebot)
Update docs
2020-02-14 17:12:36 +08:00
![Python Version](https://img.shields.io/badge/python-3.7+-blue.svg)
change readme
2020-08-23 10:57:46 +08:00
![CQHTTP Version](https://img.shields.io/badge/cqhttp-11+-black.svg)
Update README
2019-01-02 12:45:05 +08:00
[![QQ 群](https://img.shields.io/badge/qq%E7%BE%A4-768887710-orange.svg)](https://jq.qq.com/?_wv=1027&k=5OFifDh)
Bump version to 0.3.1
2018-08-26 13:44:54 +08:00
[![Telegram](https://img.shields.io/badge/telegram-chat-blue.svg)](https://t.me/cqhttp)
Update README
2018-12-24 12:41:08 +08:00
[![QQ 版本发布群](https://img.shields.io/badge/%E7%89%88%E6%9C%AC%E5%8F%91%E5%B8%83%E7%BE%A4-218529254-green.svg)](https://jq.qq.com/?_wv=1027&k=5Nl0zhE)
[![Telegram 版本发布频道](https://img.shields.io/badge/%E7%89%88%E6%9C%AC%E5%8F%91%E5%B8%83%E9%A2%91%E9%81%93-join-green.svg)](https://t.me/cqhttp_release)
Bump to v0.1.0
2018-07-22 22:29:08 +08:00
update README.md
2020-08-11 17:02:29 +08:00
</div>
Bump version to 0.3.1
2018-08-26 13:44:54 +08:00
## 简介
Update README
2018-07-01 20:37:48 +08:00
change readme
2020-08-23 10:57:46 +08:00
**NoneBot2 尚在开发中**
Update README
2018-07-01 20:37:48 +08:00
:memo: docs: guide, installation
2020-09-12 13:45:03 +08:00
NoneBot2 是一个可扩展的 Python 异步机器人框架，它会对机器人收到的消息进行解析和处理，并以插件化的形式，分发给消息所对应的命令处理器和自然语言处理器，来完成具体的功能。
Bump version to 0.3.1
2018-08-26 13:44:54 +08:00
change readme
2020-08-23 10:57:46 +08:00
除了起到解析消息的作用，NoneBot 还为插件提供了大量实用的预设操作和权限控制机制，尤其对于命令处理器，它更是提供了完善且易用的会话机制和内部调用机制，以分别适应命令的连续交互和插件内部功能复用等需求。
Bump version to 0.3.1
2018-08-26 13:44:54 +08:00
change readme
2020-08-23 10:57:46 +08:00
目前 NoneBot2 在 [FastAPI](https://fastapi.tiangolo.com/) 的基础上封装了与 [CQHTTP(OneBot) 协议](http://cqhttp.cc/)插件的网络交互。
Bump version to 0.3.1
2018-08-26 13:44:54 +08:00
change readme
2020-08-23 10:57:46 +08:00
得益于 Python 的 [asyncio](https://docs.python.org/3/library/asyncio.html) 机制，NoneBot 处理消息的吞吐量有了很大的保障，再配合 WebSocket 通信方式（也是最建议的通信方式），NoneBot 的性能可以达到 HTTP 通信方式的两倍以上，相较于传统同步 I/O 的 HTTP 通信，更是有质的飞跃。
Add diagram
2018-12-19 18:23:27 +08:00
change readme
2020-08-23 10:57:46 +08:00
需要注意的是，NoneBot 仅支持 Python 3.7+ 及 CQHTTP(OneBot) 插件 v11+。
Add diagram
2018-12-19 18:23:27 +08:00
Bump version to 0.3.1
2018-08-26 13:44:54 +08:00
## 文档
:memo: update README
2020-09-17 18:40:21 +08:00
文档目前尚未完成，「API」部分由 sphinx 自动生成，你可以在 [这里](https://v2.nonebot.dev/) 查看。
Bump version to 0.3.1
2018-08-26 13:44:54 +08:00
## 贡献
:memo: update README
2020-09-17 18:40:21 +08:00
如果你在使用过程中发现任何问题，可以 [提交 issue](https://github.com/nonebot/nonebot2/issues/new) 或自行 fork 修改后提交 pull request。
Bump version to 0.3.1
2018-08-26 13:44:54 +08:00
如果你要提交 pull request，请确保你的代码风格和项目已有的代码保持一致，遵循 [PEP 8](https://www.python.org/dev/peps/pep-0008/)，变量命名清晰，有适当的注释。
Reference in New Issue Copy Permalink