From 3f36ca114d42c6734795a78d0adda60115ce150b Mon Sep 17 00:00:00 2001 From: Maiko Sinkyaet Tan Date: Thu, 30 Nov 2023 21:42:20 +0800 Subject: [PATCH] chore: update README.zh-CN.md --- README.zh-CN.md | 44 ++++++-------------------------------------- 1 file changed, 6 insertions(+), 38 deletions(-) diff --git a/README.zh-CN.md b/README.zh-CN.md index bd15e5b..f66258a 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -17,36 +17,14 @@ ## 安装方式 -该插件可以通过插件市场安装,也可以通过包管理器安装。 +该插件可以[通过插件市场安装](https://koishi.chat/zh-CN/manual/usage/market.html),直接在插件市场中搜索本插件的名称「`hitokoto`」并进行安装即可。 -### 插件市场安装 - -如果你已经有一个完整可运行的 koishi 环境,并且添加了插件市场插件,那么你可以直接在插件市场中搜索本插件的名称「`hitokoto`」并进行安装。 - -### 手动安装 - -如果你想要手动安装本插件,你应该确保你的系统已经安装了 `npm` 或者 `yarn`,然后运行下面的命令: +你也可以使用 `yarn` 或 `npm` 手动安装本插件: ```bash -# 如果你使用的是 npm -$ npm install --save koishi-plugin-hitokoto -# 如果你使用的是 yarn $ yarn add koishi-plugin-hitokoto -``` - -当你使用包管理器安装完毕后,还需要将此插件的名称填入你的 koishi 配置文件。 - -我们假设你的配置文件是 YAML 格式,你需要像下面这样添加一个配置项: - -```yaml ---- -# ... -plugins: - hitokoto: - # 添加你需要的配置,具体见下面的配置项介绍 - apiUrl: https://api.hitokoto.cn/ - minLength: 0 - maxLength: 30 +# 也可以用 npm +$ npm install --save koishi-plugin-hitokoto ``` ## 配置 @@ -60,19 +38,9 @@ plugins: | `maxLength` | `number` | 否 | 30 | 句子最大长度,可在调用指令时用选项覆盖。 | | `defaultTypes` | `Array` | 否 | 所有类型 | 默认句子类型,可在调用指令时用选项覆盖。若传入的是空字符串,则当作 `['a']` 类型。 | -## 多语言 - -这个插件支持多语言。 - -### 支持语言 - -- 简体中文 - [@MaikoTan](https://github.com/MaikoTan) -- 英语 - [@MaikoTan](https://github.com/MaikoTan) -- 日语 - [@MaikoTan](https://github.com/MaikoTan) - -### 贡献翻译 +## 国际化 -我们通过 [Crowdin](https://crowdin.com/) 网站本地化这个项目。 +本插件支持多语言。我们通过 [Crowdin](https://crowdin.com/) 网站本地化这个项目。 如果你愿意提供翻译,请注册一个 [Crowdin](https://crowdin.com/)的帐号,然后在 [hatsushimo](https://crowdin.com/project/hatsushimo) 项目的 `hitokoto` 文件夹中贡献您的翻译。