From 5a3501519559818637f108126db92ab49a4ef8ea Mon Sep 17 00:00:00 2001 From: Ju4tCode <42488585+yanyongyu@users.noreply.github.com> Date: Fri, 2 Sep 2022 11:37:02 +0800 Subject: [PATCH] :memo: update documentation --- README.md | 38 +++++++++++++++++++++++------------- website/static/adapters.json | 2 +- 2 files changed, 25 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index e2c6f87d..42178831 100644 --- a/README.md +++ b/README.md @@ -38,15 +38,15 @@ _✨ 跨平台 Python 异步机器人框架 ✨_ onebot - - dingtalk - telegram feishu + + dingtalk + QQ频道 @@ -92,17 +92,27 @@ NoneBot2 是一个现代、跨平台、可扩展的 Python 聊天机器人框架 - 生而可靠：100% 类型注解覆盖，配合编辑器的类型推导功能，能将绝大多数的 Bug 杜绝在编辑器中 ([编辑器支持](https://v2.nonebot.dev/docs/start/editor-support)) - 社区丰富：社区用户众多，直接和间接用户超过十万人，每天都有大量的活跃用户 ([社区资源](#社区资源)) - 海纳百川：一个框架，支持多个聊天软件平台，可自定义通信协议 - - [OneBot 协议](https://onebot.dev/) (QQ 等) - - [钉钉](https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p) - - [Telegram](https://core.telegram.org/bots/api) - - [飞书](https://open.feishu.cn/document/home/index) - - [QQ 频道](https://bot.q.qq.com/wiki/) -- 坚实后盾：支持多种 web 框架，可自定义替换 - - [FastAPI](https://fastapi.tiangolo.com/) - - [Quart](https://pgjones.gitlab.io/quart/) (异步 Flask) - - [aiohttp](https://docs.aiohttp.org/en/stable/) - - [httpx](https://www.python-httpx.org/) - - [websockets](https://websockets.readthedocs.io/en/stable/) + + | 协议名称 | 状态 | 注释 | + | :---------------------------------------------------: | :--: | :----------------------------------------------------------------: | + | [OneBot 协议](https://onebot.dev/) | ✅ | 支持 QQ、TG、微信公众号等[平台](https://onebot.dev/ecosystem.html) | + | [Telegram](https://core.telegram.org/bots/api) | ✅ | | + | [飞书](https://open.feishu.cn/document/home/index) | ✅ | | + | [QQ 频道](https://bot.q.qq.com/wiki/) | ✅ | 官方接口调整较多 | + | [钉钉](https://open.dingtalk.com/document/) | 🤗 | 寻找 Maintainer | + | Console | ✅ | 控制台交互 | + | [开黑啦](https://developer.kookapp.cn/) | ↗️ | 由社区贡献 | + | [Mirai](https://docs.mirai.mamoe.net/mirai-api-http/) | ↗️ | 由社区贡献 | + +- 坚实后盾：支持多种 web 框架，可自定义替换、组合 + + | 驱动框架 | 类型 | + | :--------------------------------------------------------: | :----: | + | [FastAPI](https://fastapi.tiangolo.com/) | 服务端 | + | [Quart](https://pgjones.gitlab.io/quart/) (异步 Flask) | 服务端 | + | [aiohttp](https://docs.aiohttp.org/en/stable/) | 客户端 | + | [httpx](https://www.python-httpx.org/) | 客户端 | + | [websockets](https://websockets.readthedocs.io/en/stable/) | 客户端 | 更多：[概览](https://v2.nonebot.dev/docs/) diff --git a/website/static/adapters.json b/website/static/adapters.json index 7cd585ce..f0ac290a 100644 --- a/website/static/adapters.json +++ b/website/static/adapters.json @@ -87,6 +87,6 @@ "author": "Melodyknit", "homepage": "https://github.com/nonebot/adapter-console", "tags": [], - "is_official": false + "is_official": true } ] \ No newline at end of file