# GitHub Release Writer


<a href="https://raw.githubusercontent.com/jaid/github-release-writer/master/license.txt"><img src="https://img.shields.io/github/license/jaid/github-release-writer?style=flat-square" alt="License"/></a> <a href="https://github.com/sponsors/jaid"><img src="https://img.shields.io/badge/<3-Sponsor-FF45F1?style=flat-square" alt="Sponsor github-release-writer"/></a>  
<a href="https://actions-badge.atrox.dev/jaid/github-release-writer/goto"><img src="https://img.shields.io/endpoint.svg?style=flat-square&url=https%3A%2F%2Factions-badge.atrox.dev%2Fjaid%2Fgithub-release-writer%2Fbadge" alt="Build status"/></a> <a href="https://github.com/jaid/github-release-writer/commits"><img src="https://img.shields.io/github/commits-since/jaid/github-release-writer/v2.3.3?style=flat-square&logo=github" alt="Commits since v2.3.3"/></a> <a href="https://github.com/jaid/github-release-writer/commits"><img src="https://img.shields.io/github/last-commit/jaid/github-release-writer?style=flat-square&logo=github" alt="Last commit"/></a> <a href="https://github.com/jaid/github-release-writer/issues"><img src="https://img.shields.io/github/issues/jaid/github-release-writer?style=flat-square&logo=github" alt="Issues"/></a>  
<a href="https://npmjs.com/package/github-release-writer"><img src="https://img.shields.io/npm/v/github-release-writer?style=flat-square&logo=npm&label=latest%20version" alt="Latest version on npm"/></a> <a href="https://github.com/jaid/github-release-writer/network/dependents"><img src="https://img.shields.io/librariesio/dependents/npm/github-release-writer?style=flat-square&logo=npm" alt="Dependents"/></a> <a href="https://npmjs.com/package/github-release-writer"><img src="https://img.shields.io/npm/dm/github-release-writer?style=flat-square&logo=npm" alt="Downloads"/></a>

**Generates and inserts changelogs into GitHub releases for Node packages.**






## Installation

<a href="https://npmjs.com/package/github-release-writer"><img src="https://img.shields.io/badge/npm-github--release--writer-C23039?style=flat-square&logo=npm" alt="github-release-writer on npm"/></a>

```bash
npm install --global github-release-writer@^2.3.3
```

<a href="https://yarnpkg.com/package/github-release-writer"><img src="https://img.shields.io/badge/Yarn-github--release--writer-2F8CB7?style=flat-square&logo=yarn&logoColor=white" alt="github-release-writer on Yarn"/></a>

```bash
yarn global add github-release-writer@^2.3.3
```












## CLI Usage
After installing package `github-release-writer` globally, you can use its command line interface.
```bash
github-release-writer
```
For usage instructions:
```bash
github-release-writer --help
```










## Development

<details>
<summary><b>Development hints for maintaining and improving GitHub Release Writer</b></summary>



Setting up:
```bash
git clone git@github.com:jaid/github-release-writer.git
cd github-release-writer
npm install
```
Testing:
```bash
npm run test:dev
```
Testing in production environment:
```bash
npm run test
```

</details>

## License
[MIT License](https://raw.githubusercontent.com/jaid/github-release-writer/master/license.txt)  
Copyright © 2021, Jaid \<jaid.jsx@gmail.com> (https://github.com/jaid)

<!---
Readme generated with tldw v7.3.1
https://github.com/Jaid/tldw
-->