Short description about the intended purpose of the package.E.g. This package offers a way to create and manage dragons.
How does one use this package? Provide examples. E.g.
Package can be installed from NPM registry via npm i dragon
Documents the public API fo the module. E.g. Creating a new dragon
import dragon from 'dragon'
const newDragon = dragon.createDragon({ name: 'Drogon', age: 2000 })
Domesticating a dragon
import dragon from 'dragon'
const newDragon = dragon.createDragon({ name: 'Drogon', age: 2000 })
newDragon.domesticate();
Short guide on how to start development of the package.Instructions that will get you a copy of the package on your local machine for development and testing purposes.
What does one need pre-installed or prepared before running this package. E.g.
- Node.js >= 9.00
- npm > 5.0.0
- jest
How does one run the testsuite (and code cov if available). E.g.
Run the test suite with
npm test
Verify the code coverage with
npm run codecov
How does one deploy a new version of the package. E.g.
To deploy a new version increase the version via npm version patch and create a new release/tag.
Short set of guidelines (if any) for contributing to the development of this project. E.g.
- Increase code coverage, do not decrease it
- Update the changelist
A summary of the changes included in each version. E.g.
- v1.2.0 Added new feature
- v1.1.0 Extended API method
- v1.0.0 Initial version