You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,12 +29,13 @@ Like this template? Please consider [supporting the development ❤️](https://
29
29
1. Copy `.env.template` to `.env` and change the values inside if needed
30
30
2. Search for `#REPLACE:` with your IDE in the entire project and replace all placeholders with your own values
31
31
3. Replace the icon at `assets/icon.png` with your own or use [Google's or DuckDuckGo's favicon API](https://codepen.io/djekl/pen/QWKNNjv) in the userscript header (see step 5)
32
-
4. Replace the LICENSE.txt file with your own license or remove it if you want your code to be "all rights reserved" (needs to be adjusted in the `license` field of `package.json` too!)
32
+
4. Replace the LICENSE.txt file with your own license or remove it if you want your code to be "all rights reserved"
33
+
The `license` prop of `package.json` needs to have its [SPDX identifier](https://spdx.org/licenses) adjusted too! (Set it to `"UNLICENSED"` in case of "all rights reserved")
33
34
5. Modify the userscript header inside `src/tools/post-build.ts` to whatever you need (see also [GM header reference](https://wiki.greasespot.net/Metadata_Block))
34
35
6. The eslint configuration at `.eslintrc.cjs` is what I use, feel free to remove rules if there are too many or modify them to your preferences
35
-
7.Add your own initialization functions to `init()` and `run()` inside the entrypoint file at `src/index.ts`(read the comments for more info)
36
-
8.Refer to the sections [project structure](#project-structure), [commands](#commands) and [development](#development-tips-and-notes) next.
37
-
If you need a real world example, you can take a look at my [BetterYTM](https://github.com/Sv443/BetterYTM) project, which this template is based on.
36
+
7.Refer to the entrypoints `init()` and `run()` inside the file `src/index.ts`for hooking up your own runtime code. Read the comments in said file for more info.
37
+
8.Next, refer to the sections [project structure](#project-structure), [commands](#commands) and [development](#development-tips-and-notes).
38
+
If you need a real world example, you can take a look at my [BetterYTM](https://github.com/Sv443/BetterYTM) project, which was the origin of this template.
0 commit comments