revert README

Author: CodFrm

CONTRIBUTING.md

@@ -1,27 +1,22 @@
 # ScriptCat 贡献指南
 
-我们非常感谢你为 ScriptCat 做出贡献！本指南旨在帮助你以更规范的方式向 ScriptCat
-提交贡献，因此请务必认真阅读。
+我们非常感谢你为 ScriptCat 做出贡献！本指南旨在帮助你以更规范的方式向 ScriptCat 提交贡献，因此请务必认真阅读。
 
 ## 提交 Issue
 
-在提交 Issue 前，我们建议你先查看
-[已有的 Issues](https://github.com/scriptscat/scriptcat/issues)，以避免重复提交。
+在提交 Issue 前，我们建议你先查看 [已有的 Issues](https://github.com/scriptscat/scriptcat/issues)，以避免重复提交。
 
 ### 报告问题、故障与漏洞
 
-ScriptCat 是一个不断发展的项目。如果你在使用过程中发现问题，并且确信这些问题是由
-ScriptCat 引起的，欢迎提交 Issue。在提交时，请附带详细的复现步骤和运行环境信息。
+ScriptCat 是一个不断发展的项目。如果你在使用过程中发现问题，并且确信这些问题是由 ScriptCat 引起的，欢迎提交 Issue。在提交时，请附带详细的复现步骤和运行环境信息。
 
 ### 提出新功能
 
-我们欢迎你在 Issue
-中提出新的功能建议。为了让我们更好地理解你的需求，建议你尽可能详细地描述这个功能，并提供你认为可能的解决方案。
+我们欢迎你在 Issue 中提出新的功能建议。为了让我们更好地理解你的需求，建议你尽可能详细地描述这个功能，并提供你认为可能的解决方案。
 
 ## Pull Request
 
-ScriptCat 使用 [pnpm](https://pnpm.io/) 来管理项目依赖。如果你已经安装了
-npm，以下的命令可以帮助你快速配置开发环境：
+ScriptCat 使用 [pnpm](https://pnpm.io/) 来管理项目依赖。如果你已经安装了npm，以下的命令可以帮助你快速配置开发环境：
 
 ```bash
 # 安装 node.js 依赖
@@ -31,16 +26,13 @@ pnpm install
 我们推荐使用[代理](https://pnpm.io/npmrc#https-proxy)来解决 pnpm 的网络问题，而不是使用镜像。
 
 ```bash
-# 设置代理(linux/mac)
-export HTTPS_PROXY=http://127.0.0.1:1080
-# 设置代理(windows)
-set HTTPS_PROXY=http://127.0.0.1:1080
+pnpm config set proxy http://127.0.0.1:7890
+pnpm config set https-proxy https://127.0.0.1:7890
 ```
 
 ### Commit 规范
 
-我们希望每一个 commit 都能清晰地描述其目的，每个 commit
-应尽可能只包含一个修改。我们的 commit message 格式遵循
+我们希望每一个 commit 都能清晰地描述其目的，每个 commit 应尽可能只包含一个修改。我们的 commit message 格式遵循
 [gitmoji](https://gitmoji.dev/) 规范。例如：
 
 ```bash
@@ -62,12 +54,9 @@ git commit -m "✨ add login feature"
 
 ## 撰写文档
 
-ScriptCat
-的文档在另外的仓库中：[scriptcat.org](https://docs.scriptcat.org)，使用
-[docusaurus](https://docusaurus.io/)进行撰写，这有一些
-[Markdown](https://docusaurus.io/zh-CN/docs/markdown-features)
-特性可以帮助你。如果你需要在本地预览修改后的文档，可以使用以下命令安装文档依赖并启动
-dev server：
+ScriptCat的文档在另外的仓库中：[scriptcat.org](https://docs.scriptcat.org)，使用
+[docusaurus](https://docusaurus.io/)进行撰写，这有一些 [Markdown](https://docusaurus.io/zh-CN/docs/markdown-features)
+特性可以帮助你。如果你需要在本地预览修改后的文档，可以使用以下命令安装文档依赖并启动dev server：
 
 ```bash
 npm install
@@ -76,27 +65,27 @@ npm start
 
 ### 帮助我们翻译
 
-[Crowdin](https://crowdin.com/project/scriptcat) 是一个在线的多语言翻译平台。如果您有兴趣帮助我们翻译 ScriptCat 的相关内容，您可以在 Crowdin 上找到 ScriptCat 项目，并开始进行翻译工作。
+[Crowdin](https://crowdin.com/project/scriptcat)
+是一个在线的多语言翻译平台。如果您有兴趣帮助我们翻译 ScriptCat 的相关内容，您可以在 Crowdin 上找到 ScriptCat 项目，并开始进行翻译工作。
 
 - `src/locales`为[扩展](https://github.com/scriptscat/scriptcat)翻译文件目录
 - `public/locales`为[脚本站](https://github.com/scriptscat/scriptlist-frontend)的翻译文件目录
 
 #### 扩展开启所见即所得模式
 
-扩展开启所见即所得模式需要使用`npm run i18n`模式进行构建，然后通过控制台设置伪语言`localStorage['language']='ach-UG';`，然后刷新页面。
+> 新版本暂未补充
 
 #### 脚本站开启所见即所得模式
 
 脚本站访问：[https://scriptcat.org/ach-UG](https://scriptcat.org/ach-UG) 即可开启所见即所得模式
 
 ## 参与开发
 
-ScriptCat 使用 ESLint 来规范代码风格，使用 Jest
-来进行单元测试。你可以使用以下命令来运行：
+ScriptCat 使用 ESLint 来规范代码风格，使用 Vitest 来进行单元测试。你可以使用以下命令来运行：
 
 ```bash
-npm test
-npm run lint
+pnpm test
+pnpm run lint
 ```
 
 ScriptCat 的页面开发使用了以下技术：
@@ -109,17 +98,19 @@ ScriptCat 的页面开发使用了以下技术：
 如果你想在本地运行 ScriptCat，可以使用以下命令：
 
 ```bash
-npm run dev
+pnpm run dev
+# 请注意，由于未知原因，如果你需要使用隐身窗口，你需要使用下面的命令进行开发
+pnpm run dev:noMap
 ```
 
 如果你想打包扩展，可以使用以下命令：
 
 ```bash
-npm run pack
+pnpm run pack
 ```
 
 在打包前，请确保在`dist`目录下生成了`scriptcat.pem`文件。
 
 ## 注意问题
 
-- `npm run dev`之后需要把`dist/ext`目录里面内容在浏览器扩展里面导入加载，然后开始改代码保存即可，浏览器是实时更新的，但是涉及到`manifest.json`、`service_worker`、`offscreen`、`sandbox`的改动需要重新导入加载。
+- `pnpm run dev`之后需要把`dist/ext`目录里面内容在浏览器扩展里面导入加载，然后开始改代码保存即可，浏览器是实时更新的，但是涉及到`manifest.json`、`service_worker`、`offscreen`、`sandbox`的改动需要重新加载。

README.md

@@ -1,23 +1,97 @@
-# Rspack Project
+<h1 align="center">ScriptCat</h1>
 
-## Setup
+<p align="center">
+<img src="./build/assets/logo.png"/>
+</p>
 
-Install the dependencies:
+<p align="center">脚本猫,一个可以执行用户脚本的浏览器扩展,万物皆可脚本化,让你的浏览器可以做更多的事情!</p>
 
-```bash
-npm install
-```
+<p align="center">
+<a href="https://docs.scriptcat.org/">文档</a> ·
+<a href="https://bbs.tampermonkey.net.cn/">社区</a> ·
+<a href="https://scriptcat.org/search">脚本站</a>
+</p>
 
-## Get Started
+<p align="center">
+<a href="./README_EN.md">English README</a>
+</p>
 
-Start the dev server:
+![GitHub stars](https://img.shields.io/github/stars/scriptscat/scriptcat.svg)
+[![Build Status](https://github.com/scriptscat/scriptcat/workflows/build/badge.svg?branch=main)](https://github.com/scriptscat/scriptcat)
+[![codecov](https://codecov.io/gh/scriptscat/scriptcat/branch/main/graph/badge.svg?token=G1A6ZGDQTY)](https://codecov.io/gh/scriptscat/scriptcat)
+![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/scriptscat/scriptcat.svg?label=version)
+[![Chrome](https://img.shields.io/badge/chrome-sucess-brightgreen?logo=google%20chrome)](https://chrome.google.com/webstore/detail/scriptcat/ndcooeababalnlpkfedmmbbbgkljhpjf)
+[![Edge](https://img.shields.io/badge/edge-sucess-brightgreen?logo=microsoft%20edge)](https://microsoftedge.microsoft.com/addons/detail/scriptcat/liilgpjgabokdklappibcjfablkpcekh)
+[![FireFox](https://img.shields.io/badge/firefox-sucess-brightgreen?logo=firefox)](https://addons.mozilla.org/zh-CN/firefox/addon/scriptcat/)
+![GitHub All Releases](https://img.shields.io/github/downloads/scriptscat/scriptcat/total)
 
-```bash
-npm run dev
-```
+## 关于脚本猫
 
-Build the app for production:
+参考了油猴的设计思路并且支持油猴脚本,实现了一个后台脚本运行的框架,提供了一些特殊的
+API,让脚本能够做更多的事情.并且提供了一个优秀的编辑器,让脚本代码编写开发更加舒服流畅.
 
-```bash
-npm run build
-```
+**如果觉得好用，顺手点个 Star 吧 ❤❤❤**
+
+## 特性
+
+- 脚本云同步,更换浏览器/重装,脚本恢复更方便.
+- 脚本订阅,创建自己的脚本合集或者让多个脚本配合使用.
+- 支持油猴脚本,无缝从其它油猴脚本管理器迁移.
+- 后台脚本,可以使你的脚本持续的运行在后台.
+- 定时脚本,可以每日定时执行,每天通过脚本定时处理事务.可用于自动签到,定时提醒等功能.
+- 丰富的 API,相比于油猴,扩展出了更多强大的 API,可以实现更多的功能.
+- 通过沙盒机制确保了用户的安全,用户确定后才会给脚本授予权限.
+- 优秀的编辑器,且提供了 API 的自动补全和 ESLint.
+- 美观的 UI
+
+...更多丰富功能加入中
+
+## 说明
+
+### 安装脚本
+
+可以从各大用户脚本市场[获取脚本](https://docs.scriptcat.org/docs/use/#%E8%8E%B7%E5%8F%96%E8%84%9A%E6%9C%AC)进行安装,脚本猫所支持的后台脚本专门建立了一个市场:[后台脚本](https://bbs.tampermonkey.net.cn/forum-68-1.html).
+
+安装方式与油猴一样,同时也是兼容绝大部分油猴脚本的,如果遇到未兼容的脚本,你可以通过[issue](https://github.com/scriptscat/scriptcat/issues)反馈给我们.
+
+对于开发者来说,也可以参考这些脚本写出自己的脚本来.
+
+### 开发文档
+
+[开发文档](https://docs.scriptcat.org/docs/dev/)尽力完善中,因为是参考油猴的设计,与油猴脚本相通的地方很多,就算你使用其它油猴管理器,你也可以参考脚本猫的文档来开发!
+
+如果开发文档有什么错误,或者你想进行补全,你可以点击下方的`编辑此页`进行修改.
+
+### 安装扩展
+
+我们已经上架了扩展商店,如果你无法访问商店内容,请在[release](https://github.com/scriptscat/scriptcat/releases)中下载
+zip 包手动进行安装
+
+#### 扩展商城
+
+- [Chrome 商店](https://chrome.google.com/webstore/detail/scriptcat/ndcooeababalnlpkfedmmbbbgkljhpjf)
+- [Edge 商店](https://microsoftedge.microsoft.com/addons/detail/scriptcat/liilgpjgabokdklappibcjfablkpcekh)
+- [FireFox 商店](https://addons.mozilla.org/zh-CN/firefox/addon/scriptcat/)
+
+### 交流
+
+- [Telegram](https://t.me/scriptscat)
+- [油猴中文网](https://bbs.tampermonkey.net.cn/)
+
+## License
+
+本项目使用 GPLv3 协议开源, 请遵守协议规定.
+
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fscriptscat%2Fscriptcat.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fscriptscat%2Fscriptcat?ref=badge_large)
+
+## 贡献
+
+请参考 [贡献指南](./CONTRIBUTING.md)
+
+### 鸣谢
+
+感谢以下开发者对 ScriptCat 作出的贡献，有你们 ScriptCat 才能变得更好！
+
+<a href="https://github.com/scriptscat/scriptcat/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=scriptscat/scriptcat&max=1000" />
+</a>

README_EN.md

@@ -0,0 +1,93 @@
+<h1 align="center">ScriptCat</h1>
+
+<p align="center">
+<img src="./build/assets/logo.png"/>
+</p>
+
+<p align="center">ScriptCat, a browser extension that can execute user scripts, everything can be scripted, allowing your browser to do more things!</p>
+
+<p align="center">
+<a href="https://docs.scriptcat.org/">Docs</a> ·
+<a href="https://bbs.tampermonkey.net.cn/">Community</a> ·
+<a href="https://scriptcat.org/search">Script Hub</a> ·
+</p>
+
+<p align="center">
+<a href="./README.md">中文说明</a>
+</p>
+
+![GitHub stars](https://img.shields.io/github/stars/scriptscat/scriptcat.svg)
+[![Build Status](https://github.com/scriptscat/scriptcat/workflows/build/badge.svg?branch=main)](https://github.com/scriptscat/scriptcat)
+[![codecov](https://codecov.io/gh/scriptscat/scriptcat/branch/main/graph/badge.svg?token=G1A6ZGDQTY)](https://codecov.io/gh/scriptscat/scriptcat)
+![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/scriptscat/scriptcat.svg?label=version)
+[![Chrome](https://img.shields.io/badge/chrome-sucess-brightgreen?logo=google%20chrome)](https://chrome.google.com/webstore/detail/scriptcat/ndcooeababalnlpkfedmmbbbgkljhpjf)
+[![Edge](https://img.shields.io/badge/edge-sucess-brightgreen?logo=microsoft%20edge)](https://microsoftedge.microsoft.com/addons/detail/scriptcat/liilgpjgabokdklappibcjfablkpcekh)
+[![FireFox](https://img.shields.io/badge/firefox-sucess-brightgreen?logo=firefox)](https://addons.mozilla.org/zh-CN/firefox/addon/scriptcat/)
+![GitHub All Releases](https://img.shields.io/github/downloads/scriptscat/scriptcat/total)
+
+## About
+
+We built a framework for executing background scripts and Greasemonkey/Tampermonkey scripts based on the design ideas of Greasemonkey/Tampermonkey. It also has several unique APIs that enable scripts to do more. Furthermore, we provide a fantastic online editor that makes script code development more pleasant and easy.
+
+**Please Star it if you find it useful. ❤❤❤**
+
+## Features
+
+- Cloud Sync: script recovery is easy when changing or reinstalling browser
+- Scripts subscription: creating your own script collections or enabling multiple scripts to work together.
+- Compatibility: allowing seamless migration from other userscript managers.
+- Background scripts: allowing your scripts to run continuously in the background.
+- Scheduled scripts: allowing for daily scheduled tasks. You can use them for automatic check-ins, timed reminders, and more.
+- Rich API: more powerful APIs than other managers, which can realize more functions.
+- Sandbox mechanism: ensuring user safety, script permissions are granted only with user consent.
+- Excellent editor: providing API auto-completion and ESLint.
+- Nice UI
+
+...More features are Coming.
+
+## Instructions
+
+### Install script
+
+You can get normal userscripts from [major userscript markets](https://docs.scriptcat.org/docs/use/#%E8%8E%B7%E5%8F%96%E8%84%9A%E6%9C%AC) and background scripts from [Background Scripts](https://bbs.tampermonkey.net.cn/forum-68-1.html) which is supported by ScriptCat.
+
+The installation method is the same as Greasemonkey/Tampermonkey, and it is also compatible with the majority of userscripts. If you encounter any incompatible scripts, you can provide feedback to us through [issues](https://github.com/scriptscat/scriptcat/issues).
+
+### Script development documentation
+
+The [Documentation](https://docs.scriptcat.org/docs/dev/) is trying its best to improve. Because it refers to the design of Greasemonkey/Tampermonkey, there are many similarities with their scripts. Even if you use other script managers, You can also refer to the documentation of ScriptCat to develop!
+
+Suppose there are any errors in the development documentation or you would like to make additions. In that case, you can click the "Edit this page" link below to make changes.
+
+### Install extension
+
+We have published our extension in the Chrome or Firefox store. If you cannot access the store, please download the ZIP package manually from the [release](https://github.com/scriptscat/scriptcat/releases) and install it.
+
+#### Extension store
+
+- [Chrome Store](https://chrome.google.com/webstore/detail/scriptcat/ndcooeababalnlpkfedmmbbbgkljhpjf)
+- [Edge Store](https://microsoftedge.microsoft.com/addons/detail/scriptcat/liilgpjgabokdklappibcjfablkpcekh)
+- [Firefox Store](https://addons.mozilla.org/zh-CN/firefox/addon/scriptcat/)
+
+### Discussion
+
+- [Telegram](https://t.me/scriptscat)
+- [油猴中文网](https://bbs.tampermonkey.net.cn/)
+
+## License
+
+This project is open source under the GPLv3 license. Please comply with the terms and conditions of the license.
+
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fscriptscat%2Fscriptcat.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fscriptscat%2Fscriptcat?ref=badge_large)
+
+## Contribution
+
+Please refer to [Contribution Guidelines](./CONTRIBUTING.md)
+
+### Thanks
+
+Thanks to the following developers for contributing to ScriptCat and making ScriptCat even better!
+
+<a href="https://github.com/scriptscat/scriptcat/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=scriptscat/scriptcat&max=1000" />
+</a>

package.json

@@ -11,7 +11,7 @@
     "coverage": "vitest run --coverage",
     "build": "cross-env NODE_ENV=production rspack build",
     "dev": "cross-env NODE_ENV=development rspack",
-    "dev-noMap": "cross-env NODE_ENV=development NO_MAP=true rspack",
+    "dev:noMap": "cross-env NODE_ENV=development NO_MAP=true rspack",
     "pack": "node ./scripts/pack.js",
     "format": "prettier --write .",
     "lint": "eslint .",