Skip to content

Commit

Permalink
docs: 增加ORM使用说明
Browse files Browse the repository at this point in the history
  • Loading branch information
BraveCowardp committed Jun 12, 2024
1 parent 260b92d commit 26e50f6
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ _✨ 鸣潮抽卡记录插件 ✨_

在群聊中展示你的鸣潮抽卡记录,目前只做了最简单的显示每个金抽数的功能,后面会增加显示内容和优化显示效果

## 💿 安装(目前还未在插件商店发布,直接clone仓库使用吧)
## 💿 安装

<details open>
<summary>使用 nb-cli 安装</summary>
<summary>使用 nb-cli 安装(推荐!)</summary>
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装

nb plugin install nonebot-plugin-wwgachalogs
Expand Down Expand Up @@ -67,6 +67,16 @@ _✨ 鸣潮抽卡记录插件 ✨_
</details>

## 🎉 使用
### 更新数据模型 <font color=#fc8403 >使用必看!!!!!</font>
本插件使用了官方推荐的`nonebot-plugin-orm`插件操作数据库,安装插件或更新插件版本后,在启动机器人前,都需要执行此命令。
```shell
nb orm upgrade
```
手动执行下列命令检查数据库模式是否与模型定义一致。机器人启动前也会自动运行此命令,并在检查失败时阻止启动。
```shell
nb orm check
```
看到`没有检测到新的升级操作`字样时,表明数据库模型已经成功创建或更新,可以启动机器人
### 指令表
| 指令 | 权限 | 需要@ | 范围 | 说明 |
|:-----:|:----:|:----:|:----:|:----:|
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "nonebot-plugin-wwgachalogs"
version = "0.1.4"
version = "0.1.5"
description = ""
authors = ["irelia"]
license = "MIT"
Expand Down

0 comments on commit 26e50f6

Please sign in to comment.