feat: readme

pk5ls20 · Apr 30, 2024 · 221e143 · 221e143
1 parent a1c62f6
commit 221e143
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 ## LiteLoaderQQNT-NekoImageGallerySearch
 
 > 🤔 Note:
-> - As this project is in the WIP phase, you will need to manually build the plugin from source and install it manually by following the instructions below
+> - As this project is in the WIP phase, you will need to download the latest build of the plugin from Artifacts in Action **(recommended)**, or manually build the plugin from source and install it manually by following the instructions below
 > - You can preview the development roadmap in [here](https://github.com/users/pk5ls20/projects/5)
 
 [![wakatime](https://wakatime.com/badge/user/4e079db9-a68b-469b-a3b4-1a7e1bb4d357/project/018e9abd-9451-41d3-81e2-e52211960018.svg)](https://wakatime.com/badge/user/4e079db9-a68b-469b-a3b4-1a7e1bb4d357/project/018e9abd-9451-41d3-81e2-e52211960018)
@@ -20,14 +20,21 @@ Another web UI for [NekoImageGallery](https://github.com/hv0905/NekoImageGallery
 
 -----
 
-## Build & Install
+## Installation
 
-### Build
+### Download the latest build of the plugin from Artifacts in Action **(Recommended)**
+1. Download the build `LiteLoaderQQNT-NekoImage.zip` from Artifacts in Action.
+2. Extract the zip to the plugin path
+
+### Build and install manually
+
+#### Build manually
 ```shell
 npm install -g yarn
 yarn install && yarn plugin-build
 ```
-### Install
+
+#### install manually
 ```shell
 cp -r LiteLoaderQQNT-NekoImage /path/to/your/LiteloaderQQNT/plugin-path
 ```

diff --git a/README_ZH.md b/README_ZH.md
@@ -1,7 +1,7 @@
 ## LiteLoaderQQNT-NekoImageGallerySearch
 
 > 🤔 提示:   
-> - 由于本项目处于WIP阶段，你需要按照下面的说明手动从源代码构建插件并手动安装
+> - 由于本项目处于WIP阶段，你需要从Action中的Artifacts下载最新构建版插件 **（推荐）**，或按照下面的说明手动从源代码构建插件并手动安装
 > - 可以[在这里](https://github.com/users/pk5ls20/projects/5)查看本项目的开发路线图
 
 ----
@@ -22,14 +22,20 @@
 
 -----
 
-## 构建及安装
+## 安装
 
-### 构建
+### 从Action中的Artifacts下载最新构建版插件 **（推荐）**
+1. 从Action中的Artifacts下载构建好的`LiteLoaderQQNT-NekoImage.zip`
+2. 解压压缩包至插件路径
+
+### 手动构建并安装
+
+#### 手动构建
 ```shell
 npm install -g yarn
 yarn install && yarn plugin-build
 ```
-### 安装
+#### 手动安装
 ```shell
 cp -r LiteLoaderQQNT-NekoImage /path/to/your/LiteloaderQQNT/plugin-path
 ```