Skip to content

Commit a4f2595

Browse files
committed
docs(README): 更新功能特性和内容渲染部分
1 parent 417575d commit a4f2595

2 files changed

Lines changed: 16 additions & 36 deletions

File tree

README-EN.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
![AQBot](https://socialify.git.ci/AQBot-Desktop/AQBot/image?description=1&font=JetBrains+Mono&forks=1&issues=1&logo=https%3A%2F%2Fgithub.com%2FAQBot-Desktop%2FAQBot%2Fblob%2Fmain%2Fsrc%2Fassets%2Fimage%2Flogo.png%3Fraw%3Dtrue&name=1&owner=1&pattern=Floating+Cogs&pulls=1&stargazers=1&theme=Auto)
2-
31
[简体中文](./README.md) | English
42

3+
[![AQBot](https://socialify.git.ci/AQBot-Desktop/AQBot/image?description=1&font=JetBrains+Mono&forks=1&issues=1&logo=https%3A%2F%2Fgithub.com%2FAQBot-Desktop%2FAQBot%2Fblob%2Fmain%2Fsrc%2Fassets%2Fimage%2Flogo.png%3Fraw%3Dtrue&name=1&owner=1&pattern=Floating+Cogs&pulls=1&stargazers=1&theme=Auto)](https://github.com/AQBot-Desktop/AQBot)
4+
55
## Screenshots
66

77
![](.github/images/1.png)
@@ -21,14 +21,16 @@
2121
- **Message Versions** — Switch between multiple response versions per message to compare model or parameter effects
2222
- **Conversation Branching** — Fork new branches from any message node, with side-by-side branch comparison
2323
- **Conversation Management** — Pin, archive, time-grouped display, and bulk operations
24+
- **Conversation Compression** — Automatically compress lengthy conversations, preserving key information to save context space
25+
- **Multi-Model Simultaneous Response** — Ask the same question to multiple models at once, with side-by-side comparison of answers
2426

2527
### Content Rendering
2628

2729
- **Markdown Rendering** — Full support for code highlighting, LaTeX math formulas, tables, and task lists
2830
- **Monaco Code Editor** — Embedded Monaco Editor in code blocks with syntax highlighting, copy, and diff preview
2931
- **Diagram Rendering** — Built-in Mermaid flowchart and D2 architecture diagram rendering
3032
- **Artifact Panel** — Code snippets, HTML drafts, Markdown notes, and reports viewable in a dedicated panel
31-
- **Real-Time Voice Chat** — WebRTC-based real-time voice with OpenAI Realtime API support
33+
- **Real-Time Voice Chat**(Coming Soon) WebRTC-based real-time voice with OpenAI Realtime API support
3234

3335
### Search & Knowledge
3436

@@ -40,25 +42,23 @@
4042
### Tools & Extensions
4143

4244
- **MCP Protocol** — Full Model Context Protocol implementation supporting both stdio and HTTP transports
43-
- **Built-in Tools** — Ready-to-use built-in tools including file read/write, shell execution, and screenshot capture
45+
- **Built-in Tools** — Ready-to-use built-in MCP tools such as `@aqbot/fetch`
4446
- **Tool Execution Panel** — Visual display of tool call requests and return results
45-
- **Command Palette**`Cmd/Ctrl+K` global command palette for quick navigation and actions
4647

4748
### API Gateway
4849

4950
- **Local API Gateway** — Built-in local API server with native support for OpenAI-compatible, Claude, and Gemini interfaces, usable as a backend for any compatible client
5051
- **API Key Management** — Generate, revoke, and enable/disable access keys with description notes
5152
- **Usage Analytics** — Request volume and token usage analysis by key, provider, and date
52-
- **Program Policies** — Configure model whitelists and rate limits independently per connected application
5353
- **SSL/TLS Support** — Built-in self-signed certificate generation, with support for custom certificates
5454
- **Request Logs** — Complete recording of all API requests and responses passing through the gateway
55-
- **Configuration Templates** — Pre-built integration templates for popular tools such as Claude, Codex, OpenCode, and Gemini CLI
55+
- **Configuration Templates** — Pre-built integration templates for popular CLI tools such as Claude, Codex, OpenCode, and Gemini
5656

5757
### Data & Security
5858

5959
- **AES-256 Encryption** — API keys and sensitive data encrypted locally with AES-256; master key stored with 0600 permissions
6060
- **Isolated Data Directories** — Application state in `~/.aqbot/`; user files in `~/Documents/aqbot/`
61-
- **Auto Backup** — Scheduled automatic backups to local directories, WebDAV, or S3-compatible storage
61+
- **Auto Backup** — Scheduled automatic backups to local directories or WebDAV storage
6262
- **Backup Restore** — One-click restore from historical backups
6363
- **Conversation Export** — Export conversations as PNG screenshots, Markdown, plain text, or JSON
6464

@@ -116,16 +116,6 @@ sudo xattr -dr com.apple.quarantine /Applications/AQBot.app
116116

117117
After completing the above steps, the first launch may still be blocked. Go to **System Settings → Privacy & Security**, then click **Open Anyway** in the Security section. This only needs to be done once.
118118

119-
## Contributing
120-
121-
Pull Requests and Issues are welcome.
122-
123-
1. Fork the repository
124-
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
125-
3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
126-
4. Push to the branch (`git push origin feature/amazing-feature`)
127-
5. Open a Pull Request
128-
129119
## Community
130120
- [LinuxDO](https://linux.do)
131121

README.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
![AQBot](https://socialify.git.ci/AQBot-Desktop/AQBot/image?description=1&font=JetBrains+Mono&forks=1&issues=1&logo=https%3A%2F%2Fgithub.com%2FAQBot-Desktop%2FAQBot%2Fblob%2Fmain%2Fsrc%2Fassets%2Fimage%2Flogo.png%3Fraw%3Dtrue&name=1&owner=1&pattern=Floating+Cogs&pulls=1&stargazers=1&theme=Auto)
1+
简体中文 | [English](./README-EN.md)
22

3-
<a href="./README-EN.md">English</a> | 简体中文
3+
[![AQBot](https://socialify.git.ci/AQBot-Desktop/AQBot/image?description=1&font=JetBrains+Mono&forks=1&issues=1&logo=https%3A%2F%2Fgithub.com%2FAQBot-Desktop%2FAQBot%2Fblob%2Fmain%2Fsrc%2Fassets%2Fimage%2Flogo.png%3Fraw%3Dtrue&name=1&owner=1&pattern=Floating+Cogs&pulls=1&stargazers=1&theme=Auto)](https://github.com/AQBot-Desktop/AQBot)
44

55
## 运行截图
66

@@ -21,14 +21,16 @@
2121
- **消息版本** — 每条回复支持多版本切换,方便对比不同模型或参数的效果
2222
- **对话分支** — 从任意消息节点派生新分支,支持分支间对比
2323
- **对话管理** — 支持置顶、归档、按时间分组、批量操作
24+
- **对话压缩** — 自动压缩冗长对话,保留关键信息以节省上下文空间
25+
- **多模型同答案** — 同一问题同时向多个模型提问,支持答案间对比分析
2426

2527
### 内容渲染
2628

2729
- **Markdown 渲染** — 完整支持代码高亮、LaTeX 数学公式、表格、任务列表
2830
- **Monaco 代码编辑器** — 代码块内嵌 Monaco Editor,支持语法高亮、复制、diff 预览
2931
- **图表渲染** — 内置 Mermaid 流程图与 D2 架构图渲染
3032
- **Artifact 面板** — 代码片段、HTML 草稿、Markdown 笔记、报告可在独立面板中预览
31-
- **实时语音对话** — 基于 WebRTC 的实时语音,兼容 OpenAI Realtime API
33+
- **实时语音对话**(即将推出)基于 WebRTC 的实时语音,兼容 OpenAI Realtime API
3234

3335
### 搜索与知识
3436

@@ -40,16 +42,14 @@
4042
### 工具与扩展
4143

4244
- **MCP 协议** — 完整实现 Model Context Protocol,支持 stdio 和 HTTP 两种传输方式
43-
- **内置工具**提供文件读写、Shell 执行、截图等开箱即用的内置工具
45+
- **内置工具**提供`@aqbot/fetch`等开箱即用的内置MCP工具
4446
- **工具执行面板** — 可视化展示工具调用请求与返回结果
45-
- **命令面板**`Cmd/Ctrl+K` 全局命令面板,快速跳转和操作
4647

4748
### API 网关
4849

4950
- **本地 API 网关** — 内置 OpenAI 兼容、Claude、Gemini等原生接口的本地 API 服务器,可作为任意兼容客户端的后端
5051
- **API 密钥管理** — 生成、撤销、启停访问密钥,支持描述备注
5152
- **用量统计** — 按密钥、供应商、日期维度的请求量与 Token 用量分析
52-
- **程序策略** — 为每个接入程序独立配置模型白名单与速率限制
5353
- **SSL/TLS 支持** — 内置自签名证书生成,也支持挂载自定义证书
5454
- **请求日志** — 完整记录所有经过网关的 API 请求与响应
5555
- **配置模板** — 预置 Claude、Codex、OpenCode、Gemini 等常见 CLI 工具的接入配置模板
@@ -58,7 +58,7 @@
5858

5959
- **AES-256 加密** — API Key 等敏感数据使用 AES-256 加密存储于本地,主密钥权限 0600
6060
- **数据目录隔离** — 应用状态存储于 `~/.aqbot/`,用户文件存储于 `~/Documents/aqbot/`
61-
- **自动备份** — 支持定时自动备份到本地目录、WebDAV 或 S3 兼容存储
61+
- **自动备份** — 支持定时自动备份到本地目录、WebDAV的存储
6262
- **备份恢复** — 一键从历史备份恢复完整数据
6363
- **对话导出** — 支持将对话导出为 PNG 截图、Markdown、纯文本或 JSON 格式
6464

@@ -114,17 +114,7 @@ sudo xattr -dr com.apple.quarantine /Applications/AQBot.app
114114
115115
**3. macOS Ventura 及以上版本的额外步骤**
116116

117-
完成上述步骤后,首次打开时仍可能被拦截。前往「系统设置 → 隐私与安全性」,在安全性区域点击「仍要打开」即可,后续无需重复操作。
118-
119-
## 参与贡献
120-
121-
欢迎提交 Pull Request 和 Issue。
122-
123-
1. Fork 本仓库
124-
2. 创建特性分支 (`git checkout -b feature/amazing-feature`)
125-
3. 提交更改 (`git commit -m 'feat: add amazing feature'`)
126-
4. 推送到分支 (`git push origin feature/amazing-feature`)
127-
5. 创建 Pull Request
117+
完成上述步骤后,首次打开时仍可能被拦截。前往 **「系统设置 → 隐私与安全性」** ,在安全性区域点击 **「仍要打开」** 即可,后续无需重复操作。
128118

129119
## 社区支持
130120
- [LinuxDO](https://linux.do)

0 commit comments

Comments
 (0)