Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
enpitsuLin committed Apr 21, 2024
1 parent 30a18a9 commit 061624c
Showing 1 changed file with 13 additions and 25 deletions.
38 changes: 13 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@

<img align="right" src="https://github.com/enpitsuLin/rhodes-headquarters/assets/29378026/c77e4dac-5cc2-406d-a54c-c8571acbcdf7" width="320px" height="auto" alt="screenshot_popup" >

> 在浏览器中实时监控罗德岛运行状态
**通过浏览器扩展帮助博士实时监控罗德岛运行状态**

## 介绍

由工程部提供的诸多功能:
- 🧠 显示刀客塔的理智及恢复情况

- 🧠 显示博士的剩余理智及恢复情况
- 👋 罗德岛内公开招募进行情况
- 💰 与外部单位合作业务如保全派驻、剿灭作战工作进展
- 👨‍🔧 更多功能由工程部正在紧锣密鼓的开发中...
Expand All @@ -16,36 +19,21 @@

## 开发

```sh
git clone [email protected]: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) 接口类型定义参考

## 协议
Expand Down

0 comments on commit 061624c

Please sign in to comment.