.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 Weekly][downloads-weekly-img]][downloads-weekly-url] [![NPM Downloads Total][downloads-total-img]][downloads-total-url]

{%= description %}

{%= include('highlight') %}

Quality Assurance 💯

[![Code Climate][codeclimate-img]][codeclimate-url] [![Linux Build][travis-img]][travis-url] [![Code Coverage][codecov-img]][codecov-url] [![Dependencies Status][dependencies-img]][dependencies-url]

If you have any how-to kind of questions, please read Code of Conduct and join the chat room 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.

[![node security status][nodesecurity-img]][nodesecurity-url] ![Node Version Required][nodeversion-img]

Table of Contents

Install

This project requires Node.js v{%= engines.node.slice(2) %} and above. Use npm to install it.

$ npm install {%= name %}

API

Review carefully the provided examples and the working tests.

{%= apidocs('src/index.js') %}

{% if (verb.related && verb.related.list && verb.related.list.length) { %}

Related

{%= related(verb.related.list, { words: 12 }) %} {% } %}

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 and Code of Conduct documents for advices.

Author

• github/tunnckoCore
• twitter/tunnckoCore
• codementor/tunnckoCore

License

{%= copyright({ start: 2016, linkify: true, prefix: 'Copyright', symbol: '©' }) %} {%= licenseStatement %}

---

{%= include('footer') %}
Project scaffolded using [charlike-cli][].

{%= reflinks(verb.reflinks) %}

[npmv-url]: https://www.npmjs.com/package/{%= name %} [npmv-img]: https://img.shields.io/npm/v/{%= name %}.svg

[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

[license-url]: https://github.com/{%= repository %}/blob/master/LICENSE [license-img]: https://img.shields.io/npm/l/{%= name %}.svg

[downloads-weekly-url]: https://www.npmjs.com/package/{%= name %} [downloads-weekly-img]: https://img.shields.io/npm/dw/{%= name %}.svg

[downloads-total-url]: https://www.npmjs.com/package/{%= name %} [downloads-total-img]: https://img.shields.io/npm/dt/{%= name %}.svg

[codeclimate-url]: https://codeclimate.com/github/{%= repository %} [codeclimate-img]: https://img.shields.io/codeclimate/github/{%= repository %}.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

[nodesecurity-url]: https://nodesecurity.io/orgs/tunnckocore-dev/projects/{%= nspId %} [nodesecurity-img]: https://nodesecurity.io/orgs/tunnckocore-dev/projects/{%= nspId %}/badge

[nodeversion-img]: https://img.shields.io/node/v/{%= name %}.svg