{%= name %} [![npm version][npmv-img]][npmv-url] [![github release][ghrelease-img]][ghrelease-url] [![License][license-img]][license-url]
{%= description %}
Please consider following this project's author, [<%= author.name %>](https://github.com/<%= author.login %>), and ⭐ the project to show your ❤️ and support.
[![CircleCI linux build][linuxbuild-img]][linuxbuild-url]
[![CodeCov coverage status][codecoverage-img]][codecoverage-url]
[![DavidDM dependency status][dependencies-img]][dependencies-url]
[![Time Since Last Commit][last-commit-img]][last-commit-url]
If you have any how-to kind of questions, please read the Contributing Guide and Code of Conduct documents.
For bugs reports and feature requests, [please create an issue][open-issue-url] or ping
@tunnckoCore at Twitter.
[![Minimum Required Nodejs][nodejs-img]][npmv-url]
[![NPM Downloads Monthly][downloads-monthly-img]][npmv-url]
[![NPM Downloads Total][downloads-total-img]][npmv-url]
[![Share Love Tweet][shareb]][shareu]
[![Twitter][twitter-img]][twitter-url]
Project is semantically versioned & automatically released through CircleCI with Standard Release.
[![Keybase PGP][keybase-img]][keybase-url]
| Topic | Contact |
|---|---|
| Any legal or licensing questions, like private or commerical use |  |
| For any critical problems and security reports |  |
| Consulting, professional support, personal or team training |  |
| For any questions about Open Source, partnerships and sponsoring |  |
| Curited interesting news, announcements, articles, and thoughts |  |
This project requires Node.js {%= engines.node %} (see Support & Release Policy). Install it using
yarn or npm.
We highly recommend to use Yarn when you think to contribute to this project.
$ yarn add {%= name %}{% 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: 10 }) %}
back to top {% } %}
Please read the Contributing Guide and Code of Conduct documents for advices.
For bug reports and feature requests, please join our community forum and open a thread there with prefixing the title of the thread with the name of the project if there's no separate channel for it.
Consider reading the Support and Release Policy guide if you are interested in what are the supported Node.js versions and how we proceed. In short, we support latest two even-numbered Node.js release lines.
Become a Partner or Sponsor? 💵 Check the Partner, Sponsor or Omega-level tiers! 🎉 You can get your company logo, link & name on this file. It's also rendered on package page in [npmjs.com][npmv-url] and [yarnpkg.com](https://yarnpkg.com/en/package/{%= name %}) sites too! 🚀
Not financial support? Okey! Pull requests, stars and all kind of contributions are always welcome. ✨
This project is following OPEN Open Source model
Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is built on collective efforts and it's not strongly guarded by its founders.
There are a few basic ground-rules for its contributors
- Any significant modifications must be subject to a pull request to get feedback from other contributors.
- Pull requests to get feedback are encouraged for any other trivial contributions, but are not required.
- Contributors should attempt to adhere to the prevailing code-style and development workflow.
Thanks to the hard work of these wonderful people this project is alive! It follows the
all-contributors specification.
Don't hesitate to add yourself to that list if you have made any contribution! ;) See how,
here.
<%= author.name %> [💻](https://github.com/<%= repository %>/commits?author=<%= author.login %> "Code") [📖](https://github.com/<%= repository %>/commits?author=<%= author.login %> "Documentation") [💬](#question-<%= author.login %> "Answering Questions") [👀](#review-<%= author.login %> "Reviewed Pull Requests") [🔍](#fundingFinding-<%= author.login %> "Funding Finding") |
|---|
Consider showing your support to them. 💖
Copyright (c) <%= license.year %>-present, <%= author.name %> <<%= author.email %>> & contributors.
Released under the [<%= license.name %> License][license-url].
[npmv-url]: https://www.npmjs.com/package/{%= name %} [npmv-img]: https://badgen.net/npm/v/{%= name %}?icon=npm
[nodejs-img]: https://badgen.net/npm/node/{%= name %}
[ghrelease-url]: https://github.com/<%= repository %>/releases/latest [ghrelease-img]: https://badgen.net/github/release/<%= repository %>?icon=github
[license-url]: https://github.com/<%= repository %>/blob/master/LICENSE [license-img]: https://badgen.net/npm/license/{%= name %}
[linuxbuild-url]: https://circleci.com/gh/<%= repository %>/tree/master [linuxbuild-img]: https://badgen.net/circleci/github/<%= repository %>/master?label=build&icon=circleci
[codecoverage-url]: https://codecov.io/gh/<%= repository %> [codecoverage-img]: https://badgen.net/codecov/c/github/<%= repository %>?icon=codecov
[dependencies-url]: https://david-dm.org/<%= repository %> [dependencies-img]: https://badgen.net/david/dep/<%= repository %>?label=deps
[last-commit-img]: https://badgen.net/github/last-commit/<%= repository %>/master [last-commit-url]: https://github.com/<%= repository %>/commits/master
[downloads-weekly-img]: https://badgen.net/npm/dw/{%= name %}?icon=npm [downloads-monthly-img]: https://badgen.net/npm/dm/{%= name %}?icon=npm [downloads-total-img]: https://badgen.net/npm/dt/{%= name %}?icon=npm
[keybase-url]: https://keybase.io/<%= author.login %> [keybase-img]: https://badgen.net/keybase/pgp/<%= author.login %>
[twitter-url]: https://twitter.com/<%= author.login %> [twitter-img]: https://badgen.net/twitter/follow/<%= author.login %>?icon=twitter&color=1da1f2
[shareu]: https://twitter.com/intent/tweet?text=https://github.com/<%= repository %>&via=<%= author.twitter %> [shareb]: https://badgen.net/badge/twitter/share/1da1f2?icon=twitter
[open-issue-url]: https://github.com/<%= repository %>/issues/new