Skip to content

Commit 07b1715

Browse files
committed
docs: update README with comprehensive project overview, usage instructions, and contribution guidelines
1 parent d36491b commit 07b1715

File tree

1 file changed

+61
-1
lines changed

1 file changed

+61
-1
lines changed

README.md

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,63 @@
11
# MaxKB Appstore
22

3-
https://github.com/1Panel-dev/appstore/wiki/%E5%A6%82%E4%BD%95%E6%8F%90%E4%BA%A4%E8%87%AA%E5%B7%B1%E6%83%B3%E8%A6%81%E7%9A%84%E5%BA%94%E7%94%A8
3+
MaxKB 应用商店 - 强大易用的开源企业级智能体平台应用集合
4+
5+
## 📖 项目简介
6+
7+
MaxKB Appstore 是 MaxKB 智能体平台的官方应用商店,提供各类工具应用来扩展 MaxKB 的功能。通过这些应用,您可以轻松地为 MaxKB 添加联网搜索、数据库查询等能力。
8+
9+
## 🚀 现有应用
10+
11+
### 联网搜索类
12+
- **秘塔AI搜索** - 强大的AI驱动搜索引擎,提供准确的联网搜索能力
13+
14+
### 数据库查询类
15+
- **MongoDB 查询** - 支持 MongoDB 4.x 以上版本的数据库查询操作
16+
17+
## 📁 项目结构
18+
19+
```
20+
MaxKB-appstore/
21+
├── README.md # 项目说明文档
22+
├── apps/ # 应用目录
23+
│ ├── data.yaml # 应用商店配置
24+
│ ├── logo.png # 商店图标
25+
│ ├── metaso/ # 秘塔AI搜索应用
26+
│ │ ├── data.yaml # 应用配置
27+
│ │ ├── logo.png # 应用图标
28+
│ │ ├── README.md # 应用说明
29+
│ │ └── 1.0.0/ # 版本目录
30+
│ └── mongo/ # MongoDB查询应用
31+
│ ├── data.yaml # 应用配置
32+
│ ├── logo.png # 应用图标
33+
│ ├── README.md # 应用说明
34+
│ ├── requirements.txt # 依赖文件
35+
│ └── 1.0.0/ # 版本目录
36+
```
37+
38+
## 🔧 如何使用
39+
40+
1. 在 MaxKB 平台中访问应用商店
41+
2. 浏览并选择所需的应用
42+
3. 点击安装并按照说明进行配置
43+
4. 开始使用扩展功能
44+
45+
## 🤝 贡献指南
46+
47+
如果您想为 MaxKB Appstore 贡献新的应用,请参考:
48+
[如何提交自己想要的应用](https://github.com/1Panel-dev/appstore/wiki/%E5%A6%82%E4%BD%95%E6%8F%90%E4%BA%A4%E8%87%AA%E5%B7%B1%E6%83%B3%E8%A6%81%E7%9A%84%E5%BA%94%E7%94%A8)
49+
50+
### 应用开发规范
51+
52+
- 每个应用需要包含 `data.yaml` 配置文件
53+
- 提供清晰的应用说明文档
54+
- 包含适当的图标和版本管理
55+
- 遵循 MaxKB 平台的开发规范
56+
57+
58+
## 📞 联系我们
59+
60+
- 项目地址:https://github.com/1panel-dev/MaxKB-appstore
61+
- 问题反馈:请在 GitHub Issues 中提交
62+
- 文档支持:参考 MaxKB 官方文档
63+

0 commit comments

Comments
 (0)