From 30e5e2e59483646d8bc9d45bdddb453d63f77762 Mon Sep 17 00:00:00 2001 From: cxOrz Date: Fri, 7 Oct 2022 02:00:57 +0800 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 108a908..21e05fc 100644 --- a/README.md +++ b/README.md @@ -30,27 +30,27 @@ git clone https://github.com/cxOrz/chaoxing-sign-cli.git ```bash cd chaoxing-sign-cli -npm install +yarn ``` ## 运行 ⚙ ### 命令解释 -- `npm run build`：转译源码，输出到 build 文件夹；必须先转译才能运行程序； -- `npm run start`：运行程序，若有签到则手动完成，若无则退出程序； -- `npm run serve`：启动接口服务； -- `npm run monitor`：监听模式，检测到签到将自动签上，无需人工干预； +- `yarn build`：转译源码，输出到 build 文件夹；必须先转译才能运行程序； +- `yarn start`：运行程序，若有签到则手动完成，若无则退出程序； +- `yarn serve`：启动接口服务； +- `yarn monitor`：监听模式，检测到签到将自动签上，无需人工干预； ### 基本使用方式 更新仓库代码之后，先转译 ```bash -npm run build +yarn build ``` 转译完成，后续运行直至下次变更代码，不需要再转译，可以直接运行 ```bash -npm run start +yarn start ``` ## 使用须知 📄 @@ -120,14 +120,14 @@ npm run start 1. 安装 Node 环境，推荐使用 LTS 版本 2. 克隆代码 `git clone https://github.com/cxOrz/chaoxing-sign-cli.git` -3. 进入项目目录，安装依赖 `npm install` 或 `yarn` +3. 进入项目目录，安装依赖 4. 配置项目的 env.json 文件（可选） -5. 转译源码 `npm run build`（在修改任何文件后，务必转译源码使之生效） +5. 转译源码 `yarn build`（在修改任何文件后，务必转译源码使之生效） 6. 最后，使用 GNU Screen 或者 PM2 运行接口服务 还有一些事情必需知道： -- 如果要在服务器使用监听功能，在运行接口服务之前，先运行一次 `npm run monitor` 来配置默认信息，填写完成后看到 "监听中"，即可终止程序，信息已经写入本地。然后就可以运行 `npm run serve` 了。 +- 如果要通过UI点击按钮启动监听功能，则要在运行接口服务之前，先运行多次 `yarn monitor` 来配置每一个使用监听的用户的信息（一个用户一份配置，不配置无法使用UI启动监听，其他一切正常），看到 "监听中"，即可终止程序，该用户信息已经写入本地。配置完成后，就可以运行 `yarn serve` 来启动接口了。 - 如果使用腾讯文字识别来解析二维码，请在 `env.json` 文件中配置 secretId 和 secretKey，然后重新转译代码。 - 本项目构建的 Docker 镜像，一切均为默认设置，局限性较大。如要求不高，简单签个到，请随意。 @@ -149,8 +149,8 @@ npm run start 演示地址：https://prod.d6afmntd8nh5y.amplifyapp.com （部署在香港，较慢，功能阉割版仅供演示） -![](https://636c-cloudbase-1a4211-1252446325.tcb.qcloud.la/chaoxing-sign-ui/1.png) -![](https://636c-cloudbase-1a4211-1252446325.tcb.qcloud.la/chaoxing-sign-ui/2.png) +![](https://cxorz.blob.core.windows.net/static-files/ui-start.png) +![](https://cxorz.blob.core.windows.net/static-files/ui-qrcode-sign.png) ## 贡献