{%= name %} [![npm version][npmv-img]][npmv-url] [![github release][github-release-img]][github-release-url] [![License][license-img]][license-url]
{%= description %}
{% if (verb.related && verb.related.highlight) { %} You might also be interested in [{%= verb.related.highlight %}][highlighted-link] or in the other related projects. {% } %}
[![bitHound Code][bithound-code-img]][bithound-code-url]
If you have any how-to kind of questions, please read Code of Conduct and join the chat rooms or [open an issue][open-issue-url].
You may also read the Contributing Guide. There, beside "How to contribute?", we describe everything stated by the badges.
![All Contributors Spec][all-contributors-img]
This project requires Node.js v{%= engines.node.slice(2) %} or above. Install it using yarn v{%= engines.yarn.slice(2) %} or above / npm v{%= engines.npm.slice(2) %} or above.
$ yarn add {%= name %}
Review carefully the provided examples and the working tests.
{%= apidocs('src/index.js') %}
{% if (verb.related && verb.related.list && verb.related.list.length) { %}
Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your existance! {%= related(verb.related.list, { words: 12 }) %} {% } %}
Please read the Contributing Guide and Code of Conduct documents for advices.
For bugs reports and feature requests, [please create an issue][open-issue-url] or join us at our Flock chat rooms.
Thanks to the hard work of these wonderful people this project is alive and it also follows the all-contributors specification.
Pull requests, stars and all kind of contributions are always welcome.
You can see who uses {%= name %} in the USERS.md file. Please feel free adding this file if it not exists.
If you or your organization are using this project, consider adding yourself to the list of users. Thank You!
Copyright (c) {%= licenseStart %}-present, [Charlike Mike Reagent][author-link] <[email protected]>.
Released under the [{%= license %} License][license-url].
{%= include('footer') %}
Project scaffolded and managed with [hela][].
{%= reflinks(verb.reflinks) %}
[npmv-url]: https://www.npmjs.com/package/{%= name %} [npmv-img]: https://img.shields.io/npm/v/{%= name %}.svg?label=npm%20version
[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-monthly-img]: https://img.shields.io/npm/dm/{%= name %}.svg
[bithound-score-url]: https://www.bithound.io/github/{%= repository %} [bithound-score-img]: https://www.bithound.io/github/{%= repository %}/badges/score.svg
[bithound-code-url]: https://www.bithound.io/github/{%= repository %} [bithound-code-img]: https://www.bithound.io/github/{%= repository %}/badges/code.svg
[circleci-url]: https://circleci.com/gh/{%= repository %}/tree/master [circleci-img]: https://img.shields.io/circleci/project/github/{%= repository %}/master.svg
[codecov-url]: https://codecov.io/gh/{%= repository %} [codecov-img]: https://img.shields.io/codecov/c/github/{%= repository %}/master.svg
[bithound-deps-url]: https://www.bithound.io/github/{%= repository %}/dependencies/npm [bithound-deps-img]: https://www.bithound.io/github/{%= repository %}/badges/dependencies.svg
[dependencies-url]: https://david-dm.org/{%= repository %} [dependencies-img]: https://img.shields.io/david/{%= repository %}.svg
[nodesecurity-url]: https://nodesecurity.io/orgs/tunnckocore/projects/{%= nspId %}/master [nodesecurity-img]: https://nodesecurity.io/orgs/tunnckocore/projects/{%= nspId %}/badge
[nodeversion-img]: https://img.shields.io/node/v/{%= name %}.svg
[all-contributors-img]: https://img.shields.io/github/contributors/{%= repository %}.svg?label=all%20contributors&colorB=ffa500
[downloads-weekly-img]: https://img.shields.io/npm/dw/{%= name %}.svg [downloads-total-img]: https://img.shields.io/npm/dt/{%= name %}.svg
[share-love-url]: https://twitter.com/intent/tweet?text={%= encodeURI(homepage) %}&via=tunnckoCore [share-love-img]: https://img.shields.io/badge/share-love-1da1f2.svg [open-issue-url]: https://github.com/{%= repository %}/issues/new
[highlighted-link]: https://ghub.now.sh/{%= verb.related.highlight %} [author-link]: https://i.am.charlike.online