From 1f0f985b01fd269db585c85e0fb3f745bca85fdc Mon Sep 17 00:00:00 2001 From: Soulter <37870767+Soulter@users.noreply.github.com> Date: Sat, 6 Sep 2025 16:21:33 +0800 Subject: [PATCH] docs: update readme Updated README to improve clarity and organization. Changed section titles and removed unnecessary content. --- README.md | 56 ++++++++----------------------------------------------- 1 file changed, 8 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index a557100f8..dd9c99930 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,6 @@
-_✨ 易上手的多平台 LLM 聊天机器人及开发框架 ✨_ - Soulter%2FAstrBot | Trendshift [![GitHub release (latest by date)](https://img.shields.io/github/v/release/Soulter/AstrBot?style=for-the-badge&color=76bad9)](https://github.com/Soulter/AstrBot/releases/latest) @@ -27,7 +25,7 @@ _✨ 易上手的多平台 LLM 聊天机器人及开发框架 ✨_ AstrBot 是一个开源的一站式 Agentic 聊天机器人平台及开发框架。 -## ✨ 主要功能 +## 主要功能 1. **大模型对话**。支持接入多种大模型服务。支持多模态、工具调用、MCP、原生知识库、人设等功能。 2. **多消息平台支持**。支持接入 QQ、企业微信、微信公众号、飞书、Telegram、钉钉、Discord、KOOK 等平台。支持速率限制、白名单、百度内容审核。 @@ -35,7 +33,7 @@ AstrBot 是一个开源的一站式 Agentic 聊天机器人平台及开发框架 4. **插件扩展**。深度优化的插件机制，支持[开发插件](https://astrbot.app/dev/plugin.html)扩展功能，社区插件生态丰富。 5. **WebUI**。可视化配置和管理机器人，功能齐全。 -## ✨ 使用方式 +## 部署方式 #### Docker 部署 @@ -79,9 +77,7 @@ AstrBot 已由雨云官方上架至云应用平台，可一键部署。 #### 手动部署 -> 推荐使用 `uv`。 - -首先，安装 uv： +首先安装 uv： ```bash pip install uv @@ -132,22 +128,18 @@ uv run main.py | Discord | ✔ | | [KOOK](https://github.com/wuyan1003/astrbot_plugin_kook_adapter) | ✔ | | [VoceChat](https://github.com/HikariFroya/astrbot_plugin_vocechat) | ✔ | -| 微信对话开放平台 | 🚧 | -| WhatsApp | 🚧 | -| 小爱音响 | 🚧 | ## ⚡ 提供商支持情况 | 名称 | 支持性 | 类型 | 备注 | | -------- | ------- | ------- | ------- | -| OpenAI API | ✔ | 文本生成 | 也支持 DeepSeek、Gemini、Kimi、xAI 等兼容 OpenAI API 的服务 | -| Claude API | ✔ | 文本生成 | | -| Google Gemini API | ✔ | 文本生成 | | +| OpenAI | ✔ | 文本生成 | 支持任何兼容 OpenAI API 的服务 | +| Anthropic | ✔ | 文本生成 | | +| Google Gemini | ✔ | 文本生成 | | | Dify | ✔ | LLMOps | | | 阿里云百炼应用 | ✔ | LLMOps | | | Ollama | ✔ | 模型加载器 | 本地部署 DeepSeek、Llama 等开源语言模型 | | LM Studio | ✔ | 模型加载器 | 本地部署 DeepSeek、Llama 等开源语言模型 | -| LLMTuner | ✔ | 模型加载器 | 本地加载 lora 等微调模型 | | [优云智算](https://www.compshare.cn/?ytag=GPU_YY-gh_astrbot&referral_code=FV7DcGowN4hB5UuXKgpE74) | ✔ | 模型 API 及算力服务平台 | | | [302.AI](https://share.302.ai/rr1M3l) | ✔ | 模型 API 服务平台 | | | 硅基流动 | ✔ | 模型 API 服务平台 | | @@ -163,7 +155,6 @@ uv run main.py | 阿里云百炼 TTS | ✔ | 文本转语音 | | | Azure TTS | ✔ | 文本转语音 | Microsoft Azure TTS | - ## ❤️ 贡献 欢迎任何 Issues/Pull Requests！只需要将你的更改提交到此项目 ：) @@ -182,38 +173,6 @@ pip install pre-commit pre-commit install ``` -## 🌟 支持 - -- Star 这个项目！ -- 在[爱发电](https://afdian.com/a/soulter)支持我！ - -## ✨ Demo - -
👉 点击展开多张 Demo 截图 👈 - -
- - - -_✨基于 Docker 的沙箱化代码执行器（Beta 测试）✨_ - - - -_✨ 多模态、网页搜索、长文本转图片（可配置） ✨_ - - - - -_✨ 插件系统——部分插件展示 ✨_ - - - -_✨ WebUI ✨_ - -
- -
- ## ❤️ Special Thanks @@ -239,7 +198,8 @@ _✨ WebUI ✨_
-![10k-star-banner-credit-by-kevin](https://github.com/user-attachments/assets/c97fc5fb-20b9-4bc8-9998-c20b930ab097) + + _私は、高性能ですから!_