Template for userscript development.
- 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
To install all the packages necessary run:
yarn install- modify the header
- add your code to the main entry file
Build the development-version of the plugin with:
yarn build
# or use watch mode
yarn watchThe resulting userscript can then be found in the dist-folder.
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.
To run this script an userscript manager is required. E.g. Greasemonkey, Tampermonkey, Violentmonkey.
Install the userscript by downloading the latest release: userscript-template.user.js.
The userscript manager should install it automatically when the download is triggered. If not, check its respective docs.
