Skip to content
This repository has been archived by the owner on Nov 20, 2019. It is now read-only.

Latest commit

 

History

History
184 lines (131 loc) · 8.45 KB

.verb.md

File metadata and controls

184 lines (131 loc) · 8.45 KB

{%= 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. {% } %}

Quality Assurance 💯

[![bitHound Deps][bithound-code-img]][bithound-code-url] Code Style Standard [![Linux Build][travis-img]][travis-url] [![Code Coverage][codecov-img]][codecov-url] [![bitHound Score][bithound-score-img]][bithound-score-url] [![bitHound Deps][bithound-deps-img]][bithound-deps-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 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.

tunnckoCore support Code Format Prettier [![Node Security Status][nodesecurity-img]][nodesecurity-url] Conventional Commits Semantic Release ![Node Version Required][nodeversion-img] Renovate App Status

Sponsor

![All Contributors Spec][all-contributors-img] Make A Pull Request Newsletter Subscribe PayPal Author Support [![Share Love Tweet][share-love-img]][share-love-url] [![NPM Downloads Weekly][downloads-weekly-img]][npmv-url] [![NPM Downloads Monthly][downloads-monthly-img]][npmv-url] [![NPM Downloads Total][downloads-total-img]][npmv-url]

Table of Contents

Install

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 %} --dev

API

Review carefully the provided examples and the working tests.

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

back to top

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

Related Projects

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 }) %} {% } %}

back to top

Contributing

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.

Contributors

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.

Users

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!

License

Copyright (c) {%= licenseStart %}-present, [Charlike Mike Reagent][author-link] <olsten.larck@gmail.com>.
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

[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

[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://charlike.online