Skip to content

Commit 4bcb4cd

Browse files
committed
📝 docs(README): 更新项目文档以反映插件功能
- 将项目标题从通用模板更改为具体插件名称(amrita-plugin-exec) - 添加详细的功能描述,说明插件用途 - 提供完整的安装指南,包含uv和pip两种方式 - 添加基本的使用方法说明,列出可用命令
1 parent 7b83419 commit 4bcb4cd

1 file changed

Lines changed: 21 additions & 8 deletions

File tree

README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,26 @@
1-
# plugin-template
1+
# amrita-plugin-exec
22

3-
Amrita的插件模板
3+
Amrita的命令执行插件
44

5-
## How to start
5+
## 功能描述
66

7-
1. 使用`uv venv`初始化开发环境
8-
2. 使用`uv sync`同步虚拟环境
9-
3. 开始你的开发吧。
7+
这是一个为Amrita框架开发的命令执行插件,允许授权用户在聊天中执行服务器命令。
108

11-
## Environment
9+
## 安装
1210

13-
请在Actions配置`PYPI_API_TOKEN`来使用自动发布脚本。
11+
使用uv安装:
12+
13+
```bash
14+
uv add amrita-plugin-exec
15+
```
16+
17+
或者使用pip安装:
18+
19+
```bash
20+
pip install amrita-plugin-exec
21+
```
22+
23+
## 使用方法
24+
25+
在Amrita机器人中,授权用户可以使用以下命令:
26+
- `/exec <command>`:执行指定的服务器命令。

0 commit comments

Comments
 (0)