userscript-template
Template for userscript development.
Usage / Setup
Start
- Fork this repository
- delete the CHANGELOG.md (it will be re-created by the release process)
- replace the repository.url node in
package.json
- modify the name, description and author as well
- modify the contents of the README.md file to your liking
Init
To install all the packages necessary run:
yarn install
Create / Code
- modify the header
- add your code to the main entry file
Build
Build the development-version of the plugin with:
yarn build
# or use watch mode
yarn watch
# or use the dev-server
yarn serve
The resulting userscript can then be found in the dist
-folder.
Release
Start the release by manually by executing the release workflow in your GitHub actions. This will use the current state of the main branch to create the userscript files.