From 2d7353dbbbb07204b87848b2019927a1e291411f Mon Sep 17 00:00:00 2001 From: safe1ine <140062425+safe1ine@users.noreply.github.com> Date: Tue, 23 Sep 2025 16:56:45 +0800 Subject: [PATCH] Revise README structure and content Updated README to enhance clarity and organization of features and usage instructions. --- README.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a09669a..5f873ef 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ **MonkeyCode** 支持 **私有化部署**,支持接入 **本地大模型**,支持完全 **离线使用**,集成了 **代码安全扫描**能力,包含了功能远超 Cursor Team 版的企业级管理面板,支持对 AI 编程行为进行严格审计和管控。 -## 能力 +## 💡 能力 - 作为 `研发工程师`,你可以使用 VSCode 插件,获得 **对话式编程** 和 **代码智能补全** 能力 - 作为 `安全工程师`,你可以使用 MonkeyCode 对代码进行 **智能安全扫描**,提前发现代码中可能存在的 **安全风险** @@ -29,19 +29,26 @@ | ------------------------------------------------ | ------------------------------------------------ | | | | + +## 🚀 如何使用 + +### 在线使用 MonkeyCode-AI + +👋 在任意代码仓库的 PR 或 Issue 评论区中 at @monkeycode-ai 并描述需求 +🙋‍♂️ AI 工程师将在收到消息后的 30 秒内做出回应 +🔥 无需配置,仅需描述需求,就能获得 AI 工程师的帮助 + +请参考 [https://monkeycode-ai.com/](https://monkeycode-ai.com/) + +### 离线安装 + +请参考 [入门指南 - 新手必读!!!](https://monkeycode.docs.baizhi.cloud/node/0197be94-c6c1-737a-a0ca-01cd9c81e833) + ## 🔥 功能与特色 - **免费在线使用**: 无需注册,无需安装,只需要在 GitHub/GitLab/Gitee/Gitea 的任意代码仓库的任意 PR 或 Issue 评论区中 at @monkeycode-ai,就会有猴子来帮你干活 -- **与 Git 托管平台集成**: 支持和独立部署的 git 托管平台集成,实现与 **免费在线使用** 同样的效果 -- **企业级管理面板**:对使用 AI 编程行为进行严格审计和管控,确保团队协作的高效性和安全性。 - **私有化部署**:支持一键安装到私有化环境,支持完全离线使用,让你的代码隐私得到保障。 -- **代码安全扫描**:AI 生成的代码是否安全可靠?MonkeyCode 内置了安全扫描引擎,帮助你发现代码中可能存在的高风险安全漏洞。 -- **智能代码补全**:通过 AI 理解代码上下文并生成补全建议,减少手动输入代码的时间,显著提升开发效率。 -- **自然语言编程**:通过自然语言对话,让 AI 帮你自动完成编程、调试、设计、文档等工作。 - -## 🚀 安装 MonkeyCode - -请参考 [入门指南 - 新手必读!!!](https://monkeycode.docs.baizhi.cloud/node/0197be94-c6c1-737a-a0ca-01cd9c81e833) +- **企业级管理面板**:对使用 AI 编程行为进行严格审计和管控,确保团队协作的高效性和安全性。 ### 在 VS Code 中使用 MonkeyCode