# {{ packageName }}

> {{ packageDescription }}

[![Build Status](https://img.shields.io/github/actions/workflow/status/magicdawn/{{ repoName }}/ci.yml?style=flat-square&branch=main)](https://github.com/magicdawn/{{ repoName }}/actions/workflows/ci.yml)
[![Coverage Status](https://img.shields.io/codecov/c/github/magicdawn/{{ repoName }}.svg?style=flat-square)](https://codecov.io/gh/magicdawn/{{ repoName }})
[![npm version](https://img.shields.io/npm/v/{{ packageName }}.svg?style=flat-square)](https://www.npmjs.com/package/{{ packageName }})
[![npm downloads](https://img.shields.io/npm/dm/{{ packageName }}.svg?style=flat-square)](https://www.npmjs.com/package/{{ packageName }})
[![npm license](https://img.shields.io/npm/l/{{ packageName }}.svg?style=flat-square)](http://magicdawn.mit-license.org)

## Install

```sh
$ pnpm add {{ packageName }}
```

## API

```js
const {{ packageLocalName }} = require('{{ packageName }}');
```

## Changelog

[CHANGELOG.md](CHANGELOG.md)

## License

the MIT License http://magicdawn.mit-license.org