Boilerplate for creating Doz plugin
$ git clone https://github.com/dozjs/doz-plugin-starter.git your-plugin-folder
Install dev dependencies
$ npm install
- Write your plugin inside
src/
folder - Edit package.json with your info
- Set your remote repo
- Development:
- run script
start
- run script
- Production:
- run script
build:production
- run script
- Testing:
- run script
test
- run script
- Publish on NPM, you can run scripts below (automatically build for production)
release:major
(publish a major)release:minor
(publish a minor)release:patch
(publish a patch)
- Replace README.md content with README.md.sample
You can view the changelog here
doz-plugin-starter is open-sourced software licensed under the MIT license