Skip to content

Commit 5059f59

Browse files
committed
docs: update readme and faq
1 parent a4a8d21 commit 5059f59

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

FAQ.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Tampermonkey FAQ
22

3-
https://github.com/Tampermonkey/tampermonkey/issues/952#issuecomment-638373937
4-
https://github.com/Tampermonkey/tampermonkey/issues/977#issuecomment-657268478
3+
- [Scripts fail on FF because of CSP errors](https://github.com/Tampermonkey/tampermonkey/issues/952#issuecomment-638373937)
4+
- [Updating script from local file](https://github.com/Tampermonkey/tampermonkey/issues/977#issuecomment-657268478)

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
[![license](https://img.shields.io/github/license/crashmax-dev/vite-userscript-plugin)](./LICENCE)
55
[![template](https://img.shields.io/github/package-json/v/crashmax-dev/vite-userscript-template?label=vite-userscript-template)](https://github.com/crashmax-dev/vite-userscript-template)
66

7-
> ⚡️ Tampermonkey userscript developing and build plugin based on [Vite](https://vitejs.dev).
7+
> ⚡️ A plugin for developing and building a Tampermonkey userscript based on [Vite](https://vitejs.dev).
88
99
## Features
1010

1111
- 🔥 Hot reloading after changing any files.
1212
- 🔧 Configure Tampermonkey's Userscript header.
13-
- 💨 Import all `grant` by default in development mode.
14-
- 📝 Automatically add used `grant` when building for production.
13+
- 💨 Import all [`grant`](https://www.tampermonkey.net/documentation.php#_grant)'s to the header by default in development mode.
14+
- 📝 Automatic addition of used [`grant`](https://www.tampermonkey.net/documentation.php#_grant)'s in the code when building for production.
1515
- 📦 Built-in Tampermonkey's TypeScript type definition.
1616

1717
## Install
@@ -43,7 +43,11 @@ export default defineConfig((config) => {
4343
header: {
4444
name,
4545
version,
46-
match: '*://example.com'
46+
match: [
47+
'https://example.com',
48+
'https://example.org',
49+
'https://example.edu'
50+
]
4751
},
4852
server: {
4953
port: 3000
@@ -54,7 +58,7 @@ export default defineConfig((config) => {
5458
})
5559
```
5660

57-
### Setup scripts
61+
### Setup NPM scripts
5862

5963
```json
6064
// package.json
@@ -66,7 +70,7 @@ export default defineConfig((config) => {
6670
}
6771
```
6872

69-
### Setup TypeScript
73+
### Setup TypeScript [types](https://www.typescriptlang.org/tsconfig#types)
7074

7175
```json
7276
// tsconfig.json

0 commit comments

Comments
 (0)