Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* i18n: add english readme * docs: corrent some grammer * refactor: set CN readme as home * docs: polish readme * chore: LF
- Loading branch information
Showing
2 changed files
with
91 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| <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> · | ||
| <a href="./README.md">中文说明</a> | ||
| </p> | ||
|
|
||
|  | ||
| [](https://github.com/scriptscat/scriptcat) | ||
| [](https://codecov.io/gh/scriptscat/scriptcat) | ||
|  | ||
| [](https://chrome.google.com/webstore/detail/scriptcat/ndcooeababalnlpkfedmmbbbgkljhpjf) | ||
| [](https://microsoftedge.microsoft.com/addons/detail/scriptcat/liilgpjgabokdklappibcjfablkpcekh) | ||
| [](https://addons.mozilla.org/zh-CN/firefox/addon/scriptcat/) | ||
|  | ||
|
|
||
| ## 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. | ||
|
|
||
| [](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> |