From 061624cd12222d3a3f87d8600f7ed2fd622e1199 Mon Sep 17 00:00:00 2001 From: enpitsulin Date: Sun, 21 Apr 2024 14:32:25 +0800 Subject: [PATCH] docs: update readme --- README.md | 38 +++++++++++++------------------------- 1 file changed, 13 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index d0e0e91..258932b 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,13 @@ screenshot_popup -> 在浏览器中实时监控罗德岛运行状态 +**通过浏览器扩展帮助博士实时监控罗德岛运行状态** + +## 介绍 由工程部提供的诸多功能： -- 🧠 显示刀客塔的理智及恢复情况 + +- 🧠 显示博士的剩余理智及恢复情况 - 👋 罗德岛内公开招募进行情况 - 💰 与外部单位合作业务如保全派驻、剿灭作战工作进展 - 👨‍🔧 更多功能由工程部正在紧锣密鼓的开发中... @@ -16,36 +19,21 @@ ## 开发 -```sh -git clone git@github.com:enpitsuLin/rhodes-headquarters.git -cd rhodes-headquarters -pnpm i -pnpm dev -``` - -## 调试 - -### firefox: +请确保本地安装了 Node.js 和 pnpm 以及开发目标浏览器， 同时建议你用 Visual Studio Code 进行开发。 -```bash -pnpm start:firefox -``` - -### chromium: +```sh +# 安装依赖 +pnpm install -```bash -pnpm start:chromium +# 运行项目 +pnpm dev ``` -## 构建 - -```bash -pnpm build -``` +运行项目会自动打开 chrome 浏览器并添加扩展至扩展列表。 ## 特别鸣谢 -- [vitesse-webext](https://github.com/antfu/vitesse-webext) 项目模板 +- [wxt](https://github.com/wxt-dev/wxt) 基于 vite 的浏览器扩展框架 - [Enhance-for-Skland](https://github.com/LaviniaFalcone/Enhance-for-Skland) 接口类型定义参考 ## 协议