.verb.md
# {%= name %} [![npm version][npmv-img]][npmv-url] [![github release][github-release-img]][github-release-url] [![mit License][license-img]][license-url] [![NPM Downloads Total][downloads-total-img]][npmv-url]
<!--
[![NPM Downloads Weekly][downloads-weekly-img]][npmv-url]
[![NPM Downloads Total][downloads-total-img]][npmv-url] -->
> {%= description %}
<div id="thetop"></div>
{%= include('highlight') %}
## Quality Assurance :100:
[![Code Climate][codeclimate-img]][codeclimate-url]
[![Code Style Standard][standard-img]][standard-url]
[![Linux Build][travis-img]][travis-url]
[![Code Coverage][codecov-img]][codecov-url]
[![Dependencies Status][dependencies-img]][dependencies-url]
[![Renovate App Status][renovate-img]][renovate-url]
[![Node Version Required][nodeversion-img]][nodeversion-url]
If you have any _how-to_ kind of questions, please read [Code of Conduct](./CODE_OF_CONDUCT.md) and **join the chat** room or [open an issue][open-issue-url].
You may also read the [Contributing Guide](./CONTRIBUTING.md). There, beside _"How to contribute?"_, we describe everything **_stated_** by the badges.
[![tunnckoCore support][chat-img]][chat-url]
[![Code Format Prettier][prettier-img]][prettier-url]
[![Node Security Status][nodesecurity-img]][nodesecurity-url]
[![Conventional Commits][ccommits-img]][ccommits-url]
[![Semantic Release][semantic-release-img]][semantic-release-url]
[![First Timers Only][first-timers-only-img]][first-timers-only-url]
<a target="_blank" rel="nofollow" href="https://app.codesponsor.io/link/K7yYzzA5nb2ZDR4GTKmgUdfe/{%= repository %}">
<img alt="Sponsor" width="888" height="68" src="https://app.codesponsor.io/embed/K7yYzzA5nb2ZDR4GTKmgUdfe/{%=
repository %}.svg" />
</a>
<br>
<br>
[![All Contributors Spec][all-contributors-img]](#contributors)
[![Make A Pull Request][prs-welcome-img]][prs-welcome-url]
[![Newsletter Subscribe][tinyletter-img]][tinyletter-url]
[![PayPal Author Support][paypal-donate-img]][paypal-donate-url]
[![Share Love][share-love-img]][share-love-url]
[![BitHound Code][bithound-code-img]][bithound-code-url]
## Table of Contents
<!-- toc -->
## Install
This project requires [**Node.js**][nodeversion-url] **v{%= engines.node.slice(2) %}** and above. Use [**yarn**](https://yarnpkg.com) **v{%= engines.yarn.slice(2) %}** / [**npm**](https://www.npmjs.com) **v{%= engines.npm.slice(2) %}** or above to install it.
```
$ yarn add {%= name %}
```
## API
Review carefully the provided examples and the working [tests](./test/index.js).
{%= apidocs('src/index.js') %}
**[back to top](#thetop)**
{% if (verb.related && verb.related.list && verb.related.list.length) { %}
## Related
{%= related(verb.related.list, { words: 12 }) %}
{% } %}
**[back to top](#thetop)**
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue][open-issue-url].
Please read the [Contributing Guide](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) documents for advices.
## Author
- [github/tunnckoCore](https://github.com/tunnckoCore)
- [twitter/tunnckoCore](https://twitter.com/tunnckoCore)
- [codementor/tunnckoCore](https://codementor.io/tunnckoCore)
## License
{%= copyright({ start: licenseStart, linkify: true, prefix: 'Copyright', symbol: '©' }) %} {%= licenseStatement %}
***
{%= include('footer') %}
Project scaffolded and managed with [hela][].
{%= reflinks(verb.reflinks) %}
<!-- Heading badges -->
[npmv-url]: https://www.npmjs.com/package/{%= name %}
[npmv-img]: https://img.shields.io/npm/v/{%= name %}.svg?label=npm%20version
[open-issue-url]: https://github.com/{%= repository %}/issues/new
[github-release-url]: https://github.com/{%= repository %}/releases/latest
[github-release-img]: https://img.shields.io/github/release/{%= repository %}.svg?label=github%20release
[license-url]: https://github.com/{%= repository %}/blob/master/LICENSE
[license-img]: https://img.shields.io/npm/l/{%= name %}.svg
[downloads-weekly-img]: https://img.shields.io/npm/dw/{%= name %}.svg
[downloads-monthly-img]: https://img.shields.io/npm/dm/{%= name %}.svg
[downloads-total-img]: https://img.shields.io/npm/dt/{%= name %}.svg
<!-- Front line badges -->
[codeclimate-url]: https://codeclimate.com/github/{%= repository %}
[codeclimate-img]: https://img.shields.io/codeclimate/github/{%= repository %}.svg
[standard-url]: https://github.com/standard/standard
[standard-img]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[travis-url]: https://travis-ci.org/{%= repository %}
[travis-img]: https://img.shields.io/travis/{%= repository %}/master.svg?label=linux
[codecov-url]: https://codecov.io/gh/{%= repository %}
[codecov-img]: https://img.shields.io/codecov/c/github/{%= repository %}/master.svg
[dependencies-url]: https://david-dm.org/{%= repository %}
[dependencies-img]: https://img.shields.io/david/{%= repository %}.svg
[renovate-url]: https://renovateapp.com
[renovate-img]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg
<!-- Second front of badges -->
[chat-url]: https://tunnckocore.flock.com/?i=cx2xoeofjtj6eo6c
[chat-img]: https://img.shields.io/badge/chat-on_flock-brightgreen.svg
[prettier-url]: https://github.com/prettier/prettier
[prettier-img]: https://img.shields.io/badge/styled_with-prettier-f952a5.svg
[nodesecurity-url]: https://nodesecurity.io/orgs/tunnckocore-dev/projects/{%= nspId %}
[nodesecurity-img]: https://nodesecurity.io/orgs/tunnckocore-dev/projects/{%= nspId %}/badge
<!-- the original color of nsp:
[nodesec-img]: https://img.shields.io/badge/nsp-no_known_vulns-35a9e0.svg -->
[semantic-release-url]: https://github.com/semantic-release/semantic-release
[semantic-release-img]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[ccommits-url]: https://conventionalcommits.org/
[ccommits-img]: https://img.shields.io/badge/conventional_commits-1.0.0-yellow.svg
[nodeversion-url]: https://nodejs.org/en/download
[nodeversion-img]: https://img.shields.io/node/v/{%= name %}.svg
[first-timers-only-img]: https://img.shields.io/badge/first--timers--only-friendly-blue.svg
[first-timers-only-url]: http://www.firsttimersonly.com
[prs-welcome-img]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
[prs-welcome-url]: http://makeapullrequest.com
[all-contributors-img]: https://img.shields.io/github/contributors/{%= repository %}.svg?label=all%20contributors&colorB=ffa500
[bithound-deps-url]: https://www.bithound.io/github/{%= repository %}/master/dependencies/npm
[bithound-deps-img]: https://www.bithound.io/github/{%= repository %}/badges/dependencies.svg
[bithound-code-url]: https://www.bithound.io/github/{%= repository %}/master
[bithound-code-img]: https://www.bithound.io/github/{%= repository %}/badges/code.svg
[paypal-donate-url]: https://paypal.me/tunnckoCore/10
[paypal-donate-img]: https://img.shields.io/badge/paypal-donate-009cde.svg
[tinyletter-url]: https://tinyletter.com/tunnckoCore
[tinyletter-img]: https://img.shields.io/badge/newsletter-subscribe-9caaf8.svg
[share-love-url]: https://twitter.com/intent/tweet?text={%= encodeURI(homepage) %}&via=tunnckoCore
[share-love-img]: https://img.shields.io/badge/share-♥-ed1c24.svg