Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fllesser committed Dec 6, 2024
1 parent 12ea59f commit e695ddb
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 50 deletions.
1 change: 1 addition & 0 deletions .docs/NoneBotPlugin.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
63 changes: 13 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,78 +1,41 @@
<div align="center">
<a href="https://v2.nonebot.dev/store"><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/nbp_logo.png" width="180" height="180" alt="NoneBotPluginLogo"></a>
<br>
<p><img src="https://github.com/A-kirami/nonebot-plugin-template/blob/resources/NoneBotPlugin.svg" width="240" alt="NoneBotPluginText"></p>
<a href="https://v2.nonebot.dev/store">
<img src="./.docs/NoneBotPlugin.svg" width="300" alt="logo"></a>
</div>

<div align="center">

# nonebot-plugin-template
# nonebot-plugin-emojilike

_✨ NoneBot 插件简单描述 ✨_
_✨ NoneBot onebotV11 点赞,表情回应插件 ✨_


<a href="./LICENSE">
<img src="https://img.shields.io/github/license/owner/nonebot-plugin-template.svg" alt="license">
<img src="https://img.shields.io/github/license/fllesser/nonebot-plugin-emojilike.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-template">
<img src="https://img.shields.io/pypi/v/nonebot-plugin-template.svg" alt="pypi">
<a href="https://pypi.python.org/pypi/nonebot-plugin-emojilike">
<img src="https://img.shields.io/pypi/v/nonebot-plugin-emojilike.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.9+-blue.svg" alt="python">

</div>

这是一个 nonebot2 插件项目的模板库, 你可以直接使用本模板创建你的 nonebot2 插件项目的仓库

<details open>
<summary>模板库使用方法</summary>

1. 点击 [![start-course](https://user-images.githubusercontent.com/1221423/235727646-4a590299-ffe5-480d-8cd5-8194ea184546.svg)](https://github.com/new?template_owner=A-kirami&template_name=nonebot-plugin-template&owner=%40me&name=nonebot-plugin-&visibility=public) 创建仓库
2. 在创建好的新仓库中, 在 "Add file" 菜单中选择 "Create new file", 在新文件名处输入`LICENSE`, 此时在右侧会出现一个 "Choose a license template" 按钮, 点击此按钮选择开源协议模板, 然后在最下方提交新文件到主分支
3. 全局替换`owner`为仓库所有者ID; 全局替换`nonebot-plugin-template`为插件名; 全局替换`nonebot_plugin_template`为包名; 修改 python 徽标中的版本为你插件的运行所需版本
4. 修改 README 中的插件名和插件描述, 并在下方填充相应的内容

</details>

> [!NOTE]
> 模板库中自带了一个发布工作流, 你可以使用此工作流自动发布你的插件到 pypi
<details>
<summary>配置发布工作流</summary>

1. 前往 https://pypi.org/manage/account/#api-tokens 并创建一个新的 API 令牌。创建成功后不要关闭页面,不然你将无法再次查看此令牌。
2. 在单独的浏览器选项卡或窗口中,打开 [Actions secrets and variables](./settings/secrets/actions) 页面。你也可以在 Settings - Secrets and variables - Actions 中找到此页面。
3. 点击 New repository secret 按钮,创建一个名为 `PYPI_API_TOKEN` 的新令牌,并从第一步复制粘贴令牌。

</details>

> [!IMPORTANT]
> 这个发布工作流需要 pyproject.toml 文件, 并且只支持 [PEP 621](https://peps.python.org/pep-0621/) 标准的 pyproject.toml 文件
<details>
<summary>触发发布工作流</summary>
从本地推送任意 tag 即可触发。

创建 tag:

git tag <tag_name>

推送本地所有 tag:

git push origin --tags

</details>

## 📖 介绍

这里是插件的详细介绍部分
onebotV11 点赞,表情回应插件

## 💿 安装

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

nb plugin install nonebot-plugin-template
nb plugin install nonebot-plugin-emojilike --upgrade

</details>

Expand All @@ -83,22 +46,22 @@ _✨ NoneBot 插件简单描述 ✨_
<details>
<summary>pip</summary>

pip install nonebot-plugin-template
pip install --upgrade nonebot-plugin-emojilike
</details>
<details>
<summary>pdm</summary>

pdm add nonebot-plugin-template
pdm add nonebot-plugin-emojilike
</details>
<details>
<summary>poetry</summary>

poetry add nonebot-plugin-template
poetry add nonebot-plugin-emojilike
</details>
<details>
<summary>conda</summary>

conda install nonebot-plugin-template
conda install nonebot-plugin-emojilike
</details>

打开 nonebot2 项目根目录下的 `pyproject.toml` 文件, 在 `[tool.nonebot]` 部分追加写入
Expand Down

0 comments on commit e695ddb

Please sign in to comment.