nyg-opensource-jam3/templates/README.md

Jam3 Open Source Library Generator with no build configuration and no prompts

# [Library Name]

[Badges]

[Description]

- [Installation](#installation)
- [Usage](#usage)
- [Release](#release)
- [Tests](#tests)
- [API](#api)
- [Contributing](#contributing)
- [Support](#support)
- [Related](#related)
- [License](#license)

## Installation

```
npm install [library]
```

## Usage

[How to use it?, examples]

## Release

To releasing new versions we are using [standard-version](https://github.com/conventional-changelog/standard-version).

Steps:

1. When PRs/commits land to your master branch, select the Squash and Merge option.
2. Add a title and body that follows the [Conventional Commits Specification](https://www.conventionalcommits.org).
3. Run `$ git checkout master; git pull origin master`
4. Run `$ npm run release`
5. Run `$ git push --follow-tags origin master && npm publish`

## Tests

[What type of tests are included and how to run it]

## API

[Document what the public functions do, etc]

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting
pull requests.

## Support

Where is this library supported?

## Related

- [name](link) - Description
- [name](link) - Description
- [name](link) - Description

## License

[MIT](LICENSE)