Skip to content

Commit 637d0ac

Browse files
committed
Updated README.md
Signed-off-by: Magic <magicoflolis@tuta.io>
1 parent 4d37340 commit 637d0ac

File tree

1 file changed

+81
-39
lines changed

1 file changed

+81
-39
lines changed

README.md

Lines changed: 81 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,80 @@
11
# Magic Userscript+
22

3+
> [!IMPORTANT]
4+
> If the current webpage is set to block resources through CSP
5+
>
6+
> It will cause the userscript not work for that webpage!
7+
>
8+
> [https://developer.mozilla.org/docs/Web/HTTP/CSP](https://developer.mozilla.org/docs/Web/HTTP/CSP)
9+
310
![GitHub License](https://img.shields.io/github/license/magicoflolis/Userscript-Plus)
411
[![GitHub Release](https://img.shields.io/github/release/magicoflolis/Userscript-Plus)](https://github.com/magicoflolis/Userscript-Plus/releases/latest)
512
[![Greasy Fork Downloads](https://img.shields.io/greasyfork/dt/421603)](https://greasyfork.org/scripts/421603)
613
![jsDelivr hits (GitHub)](https://img.shields.io/jsdelivr/gh/hm/magicoflolis/Userscript-Plus)
714
[![GitHub Stars](https://img.shields.io/github/stars/magicoflolis/Userscript-Plus)](https://github.com/magicoflolis/Userscript-Plus/stargazers)
815

9-
*Fork of [Userscript+ : Show Site All UserJS](https://github.com/jae-jae/Userscript-Plus#userscript). Source code & authors information found [here](https://github.com/jae-jae/Userscript-Plus).*
16+
*Fork of [Userscript+ : Show Site All UserJS](https://github.com/jae-jae/Userscript-Plus#userscript) - authors & source code found [here](https://github.com/jae-jae/Userscript-Plus)*
1017

11-
> The power of [Greasy Fork](https://greasyfork.org) on the go! Finds available UserJS for the current webpage, **does not work on every webpage**
18+
Finds available UserJS for the current webpage, the power of [Greasy Fork](https://greasyfork.org) on the go!
1219

13-
## About
20+
| Version | Link | Alternative | Note |
21+
|:----------:|:----------:|:----------:|:----------:|
22+
| Userscript | [Greasy Fork](https://greasyfork.org/scripts/421603) | [Install (GitHub)](https://github.com/magicoflolis/Userscript-Plus/releases/latest/download/magic-userjs.user.js) | *N/A* |
23+
| Chrome/Edge/Opera | [GitHub](https://github.com/magicoflolis/Userscript-Plus/releases) | *N/A* | Work in progress |
24+
| Firefox | [GitHub](https://github.com/magicoflolis/Userscript-Plus/releases) | [Add-on Store](https://addons.mozilla.org/firefox/addon/userscript-plus/) | Work in progress |
1425

15-
> [Changelog (GitHub)](https://github.com/magicoflolis/Userscript-Plus/releases)
26+
**(Optional) Bookmarklet:**
1627

17-
Finds available UserJS for current webpage from various UserJS hosts (e.g, [Greasy Fork](https://greasyfork.org)), displays a found count bottom right of the webpage, automatically disappears after 10 seconds (can be configured).
28+
> Save this URL as a bookmark, clicking it will cause the userscript version to inject itself into the current webpage.
1829
19-
| Preview(s) |
30+
```JS
31+
javascript:(function(){['https://cdn.jsdelivr.net/gh/magicoflolis/Userscript-Plus@master/userscript/dist/magic-userjs.user.js'].map(s=>document.body.appendChild(document.createElement('script')).src=s)})();
32+
```
33+
34+
---
35+
36+
| Previews |
2037
|:----------:|
2138
|![Demo 1](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/assets/demo4.gif)|
22-
|![Demo 2](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/assets/demo3.gif)|
23-
|![Demo 3](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/assets/demo2.gif)|
24-
|![Demo 4](https://raw.githubusercontent.com/magicoflolis/Userscript-Plus/master/assets/demo1.png)|
2539

26-
## Downloads
40+
---
2741

28-
***
42+
## Features
2943

30-
| Version | Link | Alternative | Note |
31-
|:----------:|:----------:|:----------:|:----------:|
32-
| Userscript | [Greasy Fork](https://greasyfork.org/scripts/421603) | [Install (GitHub)](https://github.com/magicoflolis/Userscript-Plus/releases/latest/download/magic-userjs.user.js) | - |
33-
| Chrome/Edge/Opera | [GitHub](https://github.com/magicoflolis/Userscript-Plus/releases) | - | Work in progress |
34-
| Firefox | [GitHub](https://github.com/magicoflolis/Userscript-Plus/releases) | [Add-on Store](https://addons.mozilla.org/firefox/addon/userscript-plus/) | Work in progress |
44+
> [Changelog (GitHub)](https://github.com/magicoflolis/Userscript-Plus/releases)
3545
36-
**(Optional) Mobile Bookmarklet:**
46+
* Designed for mobile and desktop devices
47+
* Support multiple languages - date formats will match your current language
48+
* Ability to customize theme
49+
* Ability to import / export config and theme
50+
* Ability to search for userscripts
51+
* Ability to filter userscripts which do not match your current language
52+
* Ability to query userscripts from any hostname
53+
* Ability to sort userscripts, default sorting "Daily Installs"
54+
* Available search engines [Greasy Fork](https://greasyfork.org), [Sleazy Fork](https://sleazyfork.org), [Open UserJS](https://openuserjs.org), [GitHub](https://github.com/search?l=JavaScript&o=desc&q="==UserScript==") ( requires a [Personal Access Token](https://github.com/settings/tokens), the token does not require any permissions )
55+
* Built-in userscript [Greasyfork Search with Sleazyfork Results include](https://greasyfork.org/scripts/23840)
56+
* Preview any userscript code before install
57+
* Save any userscript to local file
58+
* Highlights which userscripts are created by the [author](https://greasyfork.org/users/166061)
59+
* Highlights recommended userscripts from the [author](https://greasyfork.org/users/166061)
3760

38-
```JS
39-
javascript:(function(){['https://cdn.jsdelivr.net/gh/magicoflolis/Userscript-Plus@master/userscript/dist/magic-userjs.user.js'].map(s=>document.body.appendChild(document.createElement('script')).src=s)})();
40-
```
61+
**Userscript Features:**
4162

42-
***
63+
> Tested and compatible with [TamperMonkey](https://www.tampermonkey.net/) and [ViolentMonkey](https://violentmonkey.github.io/)
4364
44-
## Features
65+
* Ability to maximize, minimize, or exit the userscript list
66+
* Ability to change the position of floating counter
67+
* Sync config with Userscript Manager or choose to have site based configs
68+
69+
**Bookmarklet Features:**
4570

46-
> Tested and compatible with TamperMonkey and ViolentMonkey.
71+
* Ability to maximize, minimize, or exit the userscript list
72+
* Ability to change the position of floating counter
73+
* Ability to choose to have site based configs
4774

48-
* Multilingual support.
49-
* User can search + load results for UserJS on an entirely different webpage!
50-
* Config can be synced with current user script manager.
51-
* Automatically finds language through ``navigator.language``, all dates will match your current language.
52-
* List displays the following information for each UserJS: name, description, creation date, author(s), version, daily installs, total installs, user ratings.
53-
* List can be filtered through search.
54-
* List is sorted by Daily Installs, highest to lowest.
55-
* Designed for desktop and mobile devices.
56-
* Available search engines: [Greasy Fork](https://greasyfork.org), [Sleazy Fork](https://sleazyfork.org), [Open UserJS](https://openuserjs.org), [GitHub](https://github.com/search?l=JavaScript&o=desc&q="==UserScript=="), [Gist (GitHub)](https://gist.github.com/search?l=JavaScript&o=desc&q="==UserScript==")
57-
* Built-in [Greasyfork Search with Sleazyfork Results include](https://greasyfork.org/scripts/23840).
75+
**Webextension Features:**
76+
77+
* *N/A*
5878

5979
## FAQ / Troubleshooting
6080

@@ -64,16 +84,16 @@ Nothing appears bottom right:
6484
* Default timeout is 10000ms before the count disappears
6585
* If issue persists, see [Viewing UserJS Logs](#viewing-userjs-logs)
6686

67-
Error occured while injecting Container:
87+
Error occurred while injecting Container:
6888

6989
* Try again on another webpage [[Test Page](https://google.com)]
7090
* This error is caused by the current webpage not supporting [attachShadow](https://developer.mozilla.org/en-US/docs/Web/API/Element/attachShadow)
7191

72-
Error occured while loading UserJS for this webpage:
92+
Error occurred while loading UserJS for this webpage:
7393

7494
* Reload the webpage or try again on a different webpage [[Test Page](https://google.com)]
7595
* This error *may* be caused by
76-
* An error occured in an enabled search engine while fetching content
96+
* An error occurred in an enabled search engine while fetching content
7797
* Script is unable to fetch content on current or all webpages
7898

7999
No available UserJS for this webpage:
@@ -88,9 +108,9 @@ No available UserJS for this webpage:
88108
* Feel free to screenshot any error messages to the [GitHub](https://github.com/magicoflolis/Userscript-Plus/issues) for addition help
89109
* If nothing appears, this means the script is not executing at all
90110

91-
## Workflows
111+
## Development
92112

93-
### Development
113+
> Code editor used - [VSCodium](https://vscodium.com)
94114
95115
Install [Node.js](https://nodejs.org/) and [pnpm](https://pnpm.io/).
96116
The version of Node.js should match `"node"` key in `package.json`.
@@ -100,7 +120,11 @@ The version of Node.js should match `"node"` key in `package.json`.
100120
$ pnpm i
101121
```
102122

103-
#### Userscript Version
123+
### Userscript Version
124+
125+
> Desktop version - developed using [ViolentMonkey](https://violentmonkey.github.io/), see [How to edit scripts with your favorite editor?](https://violentmonkey.github.io/posts/how-to-edit-scripts-with-your-favorite-editor/)
126+
>
127+
> Mobile version - developed using [FireFox Developer Edition](https://www.mozilla.org/firefox/developer/) "Responsive Design Mode" on desktop + [cromite](https://github.com/uazo/cromite) app on Android
104128
105129
``` sh
106130
# Watch and compile to local HTTP server
@@ -110,6 +134,24 @@ $ pnpm run dev:UserJS
110134
$ pnpm run pub:UserJS
111135
```
112136

137+
### Webextension Version
138+
139+
``` sh
140+
# Compile webextension (dev version) for "Chromium" to "./tests/chrome"
141+
$ pnpm run dev:Cr
142+
# Compile webextension (dev version) for "Firefox" to "./tests/chrome"
143+
$ pnpm run dev:FF
144+
# Compile webextension (public version) for "Chromium" to "./tests/chrome"
145+
$ pnpm run webpack:Cr
146+
# Compile webextension (public version) for "Firefox" to "./tests/chrome"
147+
$ pnpm run webpack:FF
148+
149+
# [ Testing ]
150+
# Browsers can be launched via "Run and Debug" in VSCode.
151+
# Edit runtimeExecutable in ".vscode/launch.json" to your Chrome executable.
152+
# Recommended to create an additional profile "about:profiles" for Firefox.
153+
```
154+
113155
### Source Code
114156

115157
* [https://github.com/magicoflolis/Userscript-Plus](https://github.com/magicoflolis/Userscript-Plus)

0 commit comments

Comments
 (0)