Skip to content

Commit acb5731

Browse files
committed
📝 调整readme
1 parent a0d6417 commit acb5731

2 files changed

Lines changed: 60 additions & 34 deletions

File tree

README.md

Lines changed: 38 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<img src="./src/assets/logo.png"/>
55
</p>
66

7-
<p align="center">脚本猫,一个可以执行用户脚本的浏览器扩展,万物皆可脚本化,让你的浏览器可以做更多的事情!</p>
7+
<p align="center">脚本猫一个可以执行用户脚本的浏览器扩展万物皆可脚本化让你的浏览器可以做更多的事情</p>
88

99
<p align="center">
1010
<a href="https://docs.scriptcat.org/">文档</a> ·
@@ -27,21 +27,21 @@
2727

2828
## 关于脚本猫
2929

30-
参考了油猴的设计思路并且支持油猴脚本,实现了一个后台脚本运行的框架,提供了一些特殊的
31-
API,让脚本能够做更多的事情.并且提供了一个优秀的编辑器,让脚本代码编写开发更加舒服流畅.
30+
参考了油猴的设计思路并且支持油猴脚本实现了一个后台脚本运行的框架提供了一些特殊的
31+
API让脚本能够做更多的事情并且提供了一个优秀的编辑器让脚本代码编写开发更加舒服流畅
3232

3333
**如果觉得好用,顺手点个 Star 吧 ❤❤❤**
3434

3535
## 特性
3636

37-
- 脚本云同步,更换浏览器/重装,脚本恢复更方便.
38-
- 脚本订阅,创建自己的脚本合集或者让多个脚本配合使用.
39-
- 支持油猴脚本,无缝从其它油猴脚本管理器迁移.
40-
- 后台脚本,可以使你的脚本持续的运行在后台.
41-
- 定时脚本,可以每日定时执行,每天通过脚本定时处理事务.可用于自动签到,定时提醒等功能.
42-
- 丰富的 API,相比于油猴,扩展出了更多强大的 API,可以实现更多的功能.
43-
- 通过沙盒机制确保了用户的安全,用户确定后才会给脚本授予权限.
44-
- 优秀的编辑器,且提供了 API 的自动补全和 ESLint.
37+
- 脚本云同步更换浏览器/重装脚本恢复更方便
38+
- 脚本订阅创建自己的脚本合集或者让多个脚本配合使用
39+
- 支持油猴脚本无缝从其它油猴脚本管理器迁移
40+
- 后台脚本可以使你的脚本持续的运行在后台
41+
- 定时脚本可以每日定时执行每天通过脚本定时处理事务可用于自动签到定时提醒等功能
42+
- 丰富的 API相比于油猴扩展出了更多强大的 API可以实现更多的功能
43+
- 通过沙盒机制确保了用户的安全用户确定后才会给脚本授予权限
44+
- 优秀的编辑器且提供了 API 的自动补全和 ESLint
4545
- 美观的 UI
4646

4747
...更多丰富功能加入中
@@ -50,21 +50,21 @@ API,让脚本能够做更多的事情.并且提供了一个优秀的编辑器,
5050

5151
### 安装脚本
5252

53-
可以从各大用户脚本市场[获取脚本](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).
53+
可以从各大用户脚本市场[获取脚本](https://docs.scriptcat.org/docs/use/#%E8%8E%B7%E5%8F%96%E8%84%9A%E6%9C%AC)进行安装脚本猫所支持的后台脚本专门建立了一个市场[后台脚本](https://scriptcat.org/zh-CN/search?script_type=3)
5454

55-
安装方式与油猴一样,同时也是兼容绝大部分油猴脚本的,如果遇到未兼容的脚本,你可以通过[issue](https://github.com/scriptscat/scriptcat/issues)反馈给我们.
55+
安装方式与油猴一样同时也是兼容绝大部分油猴脚本的如果遇到未兼容的脚本你可以通过[issue](https://github.com/scriptscat/scriptcat/issues)反馈给我们
5656

57-
对于开发者来说,也可以参考这些脚本写出自己的脚本来.
57+
对于开发者来说也可以参考这些脚本写出自己的脚本来
5858

5959
### 开发文档
6060

61-
[开发文档](https://docs.scriptcat.org/docs/dev/)尽力完善中,因为是参考油猴的设计,与油猴脚本相通的地方很多,就算你使用其它油猴管理器,你也可以参考脚本猫的文档来开发!
61+
[开发文档](https://docs.scriptcat.org/docs/dev/)尽力完善中因为是参考油猴的设计与油猴脚本相通的地方很多就算你使用其它油猴管理器你也可以参考脚本猫的文档来开发
6262

63-
如果开发文档有什么错误,或者你想进行补全,你可以点击下方的`编辑此页`进行修改.
63+
如果开发文档有什么错误或者你想进行补全你可以点击下方的`编辑此页`进行修改
6464

6565
### 安装扩展
6666

67-
我们已经上架了扩展商店,如果你无法访问商店内容,请在[release](https://github.com/scriptscat/scriptcat/releases)中下载
67+
我们已经上架了扩展商店如果你无法访问商店内容请在[release](https://github.com/scriptscat/scriptcat/releases)中下载
6868
zip 包手动进行安装
6969

7070
#### 扩展商城
@@ -73,26 +73,39 @@ zip 包手动进行安装
7373
- [Edge 商店](https://microsoftedge.microsoft.com/addons/detail/scriptcat/liilgpjgabokdklappibcjfablkpcekh)
7474
- [FireFox 商店](https://addons.mozilla.org/zh-CN/firefox/addon/scriptcat/)
7575

76-
### 交流
76+
#### Beta版本
7777

78-
- [Telegram](https://t.me/scriptscat)
79-
- [Discord](https://discord.gg/JF76nHCCM7)
80-
- [油猴中文网](https://bbs.tampermonkey.net.cn/)
78+
预发布版本是在正式发布之前的版本.它们通常用于测试新功能,预发布版本的版本号包含一个预发布标识符,例如:
79+
`1.0.0-beta.1`.
8180

82-
## License
81+
你可以从[Release](https://github.com/scriptscat/scriptcat/releases)页或者下面的扩展商店页中获取预发布版本
8382

84-
本项目使用 GPLv3 协议开源, 请遵守协议规定.
83+
- [Firefox](https://addons.mozilla.org/zh-CN/firefox/addon/scriptcat-pre/)
84+
- [Chrome](https://chromewebstore.google.com/detail/%E8%84%9A%E6%9C%AC%E7%8C%AB-beta/jaehimmlecjmebpekkipmpmbpfhdacom?authuser=0&hl=zh-CN)
85+
- [Edge](https://microsoftedge.microsoft.com/addons/detail/%E8%84%9A%E6%9C%AC%E7%8C%AB-beta/nimmbghgpcjmeniofmpdfkofcedcjpfi)
8586

86-
[![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)
87+
另外除了预发布以外,脚本猫每次代码提交合并到主分支后都会在[Github Action](https://github.com/scriptscat/scriptcat/actions/workflows/build.yaml)上打包构建一次扩展,如果你想体验最新或者修复的内容可以前往[Github Action](https://github.com/scriptscat/scriptcat/actions/workflows/build.yaml)页进行下载.
8788

8889
## 贡献
8990

9091
请参考 [贡献指南](./CONTRIBUTING.md)
9192

93+
### 交流
94+
95+
- [Telegram](https://t.me/scriptscat)
96+
- [Discord](https://discord.gg/JF76nHCCM7)
97+
- [油猴中文网](https://bbs.tampermonkey.net.cn/)
98+
9299
### 鸣谢
93100

94101
感谢以下开发者对 ScriptCat 作出的贡献,有你们 ScriptCat 才能变得更好!
95102

96103
<a href="https://github.com/scriptscat/scriptcat/graphs/contributors">
97104
<img src="https://contrib.rocks/image?repo=scriptscat/scriptcat&max=1000" />
98-
</a>
105+
</a>
106+
107+
## License
108+
109+
本项目使用 GPLv3 协议开源,请遵守协议规定。
110+
111+
[![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)

README_EN.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ We built a framework for executing background scripts and Greasemonkey/Tampermon
4949

5050
### Install script
5151

52-
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.
52+
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://scriptcat.org/en/search?script_type=3) which is supported by ScriptCat.
5353

5454
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).
5555

@@ -69,26 +69,39 @@ We have published our extension in the Chrome or Firefox store. If you cannot ac
6969
- [Edge Store](https://microsoftedge.microsoft.com/addons/detail/scriptcat/liilgpjgabokdklappibcjfablkpcekh)
7070
- [Firefox Store](https://addons.mozilla.org/zh-CN/firefox/addon/scriptcat/)
7171

72-
### Discussion
72+
#### Beta Version
7373

74-
- [Telegram](https://t.me/scriptscat)
75-
- [Discord](https://discord.gg/JF76nHCCM7)
76-
- [油猴中文网](https://bbs.tampermonkey.net.cn/)
74+
Pre-release versions are versions before the official release. They are usually used to test new features. Pre-release versions have a pre-release identifier in their version number, for example:
75+
`1.0.0-beta.1`.
7776

78-
## License
77+
You can get pre-release versions from the [Release](https://github.com/scriptscat/scriptcat/releases) page or from the extension store pages below:
7978

80-
This project is open source under the GPLv3 license. Please comply with the terms and conditions of the license.
79+
- [Firefox](https://addons.mozilla.org/zh-CN/firefox/addon/scriptcat-pre/)
80+
- [Chrome](https://chromewebstore.google.com/detail/%E8%84%9A%E6%9C%AC%E7%8C%AB-beta/jaehimmlecjmebpekkipmpmbpfhdacom?authuser=0&hl=zh-CN)
81+
- [Edge](https://microsoftedge.microsoft.com/addons/detail/%E8%84%9A%E6%9C%AC%E7%8C%AB-beta/nimmbghgpcjmeniofmpdfkofcedcjpfi)
8182

82-
[![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)
83+
In addition to pre-releases, ScriptCat also builds the extension on [Github Action](https://github.com/scriptscat/scriptcat/actions/workflows/build.yaml) every time code is committed and merged into the main branch. If you want to experience the latest features or fixes, you can visit the [Github Action](https://github.com/scriptscat/scriptcat/actions/workflows/build.yaml) page to download.
8384

8485
## Contribution
8586

8687
Please refer to [Contribution Guidelines](./docs/CONTRIBUTING_EN.md)
8788

89+
### Discussion
90+
91+
- [Telegram](https://t.me/scriptscat)
92+
- [Discord](https://discord.gg/JF76nHCCM7)
93+
- [油猴中文网](https://bbs.tampermonkey.net.cn/)
94+
8895
### Thanks
8996

9097
Thanks to the following developers for contributing to ScriptCat and making ScriptCat even better!
9198

9299
<a href="https://github.com/scriptscat/scriptcat/graphs/contributors">
93100
<img src="https://contrib.rocks/image?repo=scriptscat/scriptcat&max=1000" />
94-
</a>
101+
</a>
102+
103+
## License
104+
105+
This project is open source under the GPLv3 license. Please comply with the terms and conditions of the license.
106+
107+
[![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)

0 commit comments

Comments
 (0)