# node-update-readme

[![semantic release](https://github.com/reggi/node-update-readme/workflows/semantic%20release/badge.svg)](https://github.com/reggi/node-update-readme/actions?query=workflow%3A%22semantic+release%22) [![coverage](https://github.com/reggi/node-update-readme/workflows/coverage/badge.svg)](https://reggi.github.io/node-update-readme/) [![npm](https://badge.fury.io/js/update-readme.svg)](https://www.npmjs.com/package/update-readme)

Updates the `README.md` of a NPM package to include content from `package.json`.

## Install

```
npm install update-readme -g
update-readme
```

## Use directly via `npx`

```
npx update-readme
```

<!-- anything below this line will be safe from template removal -->