.verb.md
# {%= name %} {%= badge('npm') %} [![mit license][license-img]][license-url] {%= badge('downloads') %} [![npm total downloads][downloads-img]][downloads-url]
> {%= description %}
[![code climate][codeclimate-img]][codeclimate-url]
[![code style][standard-img]][standard-url]
[![linux build][travis-img]][travis-url]
[![windows build][appveyor-img]][appveyor-url]
[![code coverage][coverage-img]][coverage-url]
[![dependency status][david-img]][david-url]
[![paypal donate][paypalme-img]][paypalme-url]
{%= include('highlight') %}
## Table of Contents
<!-- toc -->
## Install
Install with [npm](https://www.npmjs.com/)
```
$ npm install {%= name %} --save
```
or install using [yarn](https://yarnpkg.com)
```
$ yarn add {%= name %}
```
## Usage
> For more use-cases see the [tests](test.js)
```js
const {%= varname %} = require('{%= name %}')
const regexps = {%= varname %}()
console.log(regexps)
const natives = {%= varname %}.natives
console.log(natives)
// => [ 'internal/bootstrap_node',
// '_debug_agent',
// '_debugger',
// 'assert',
// 'buffer',
// 'child_process',
// 'console',
// 'constants',
// 'crypto',
// 'cluster',
// 'dgram',
// 'dns',
// 'domain',
// 'events',
// 'fs',
// 'http',
// '_http_agent',
// '_http_client',
// '_http_common',
// '_http_incoming',
// '_http_outgoing',
// '_http_server',
// 'https',
// '_linklist',
// 'module',
// 'net',
// 'os',
// 'path',
// 'process',
// 'punycode',
// 'querystring',
// 'readline',
// 'repl',
// 'stream',
// '_stream_readable',
// '_stream_writable',
// '_stream_duplex',
// '_stream_transform',
// '_stream_passthrough',
// '_stream_wrap',
// 'string_decoder',
// 'sys',
// 'timers',
// 'tls',
// '_tls_common',
// '_tls_legacy',
// '_tls_wrap',
// 'tty',
// 'url',
// 'util',
// 'v8',
// 'vm',
// 'zlib',
// 'internal/buffer',
// 'internal/child_process',
// 'internal/cluster/child',
// 'internal/cluster/master',
// 'internal/cluster/round_robin_handle',
// 'internal/cluster/shared_handle',
// 'internal/cluster/utils',
// 'internal/cluster/worker',
// 'internal/errors',
// 'internal/freelist',
// 'internal/fs',
// 'internal/linkedlist',
// 'internal/net',
// 'internal/module',
// 'internal/process/next_tick',
// 'internal/process/promises',
// 'internal/process/stdio',
// 'internal/process/warning',
// 'internal/process',
// 'internal/querystring',
// 'internal/process/write-coverage',
// 'internal/readline',
// 'internal/repl',
// 'internal/socket_list',
// 'internal/url',
// 'internal/util',
// 'internal/v8_prof_polyfill',
// 'internal/v8_prof_processor',
// 'internal/streams/lazy_transform',
// 'internal/streams/BufferList',
// 'internal/streams/legacy',
// 'v8/tools/splaytree',
// 'v8/tools/codemap',
// 'v8/tools/consarray',
// 'v8/tools/csvparser',
// 'v8/tools/profile',
// 'v8/tools/profile_view',
// 'v8/tools/logreader',
// 'v8/tools/tickprocessor',
// 'v8/tools/SourceMap',
// 'v8/tools/tickprocessor-driver',
// 'node-inspect/lib/_inspect',
// 'node-inspect/lib/internal/inspect_client',
// 'node-inspect/lib/internal/inspect_repl',
// 'bootstrap_node',
// 'node' ]
```
{% if (verb.related && verb.related.list && verb.related.list.length) { %}
## Related
{%= related(verb.related.list, {words: 20}) %}
{% } %}
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/{%= repository %}/issues/new).
Please read the [contributing guidelines](CONTRIBUTING.md) for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to [contact me at CodeMentor.io](https://www.codementor.io/tunnckocore?utm_source=github&utm_medium=button&utm_term=tunnckocore&utm_campaign=github) too.
**In short:** If you want to contribute to that project, please follow these things
1. Please DO NOT edit [README.md](README.md), [CHANGELOG.md](CHANGELOG.md) and [.verb.md](.verb.md) files. See ["Building docs"](#building-docs) section.
2. Ensure anything is okey by installing the dependencies and run the tests. See ["Running tests"](#running-tests) section.
3. Always use `npm run commit` to commit changes instead of `git commit`, because it is interactive and user-friendly. It uses [commitizen][] behind the scenes, which follows Conventional Changelog idealogy.
4. Do NOT bump the version in package.json. For that we use `npm run release`, which is [standard-version][] and follows Conventional Changelog idealogy.
Thanks a lot! :)
## Building docs
Documentation and that readme is generated using [verb-generate-readme][], which is a [verb][] generator, so you need to install both of them and then run `verb` command like that
```
$ npm install verbose/verb#dev verb-generate-readme --global && verb
```
_Please don't edit the README directly. Any changes to the readme must be made in [.verb.md](.verb.md)._
## Running tests
Clone repository and run the following in that cloned directory
```
$ npm install && npm test
```
## Author
{%= includeEither('authors', 'author') %}
+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)
## License
{%= copyright({ start: 2016, linkify: true, prefix: 'Copyright', symbol: '©' }) %} {%= licenseStatement %}
***
{%= include('footer') %}
_Project scaffolded using [charlike][] cli._
{%= reflinks(verb.reflinks) %}
[license-url]: https://www.npmjs.com/package/{%= name %}
[license-img]: https://img.shields.io/npm/l/{%= name %}.svg
[downloads-url]: https://www.npmjs.com/package/{%= name %}
[downloads-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
[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/{%= name %}
[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/{%= name %}/master.svg?label=windows
[coverage-url]: https://codecov.io/gh/{%= repository %}
[coverage-img]: https://img.shields.io/codecov/c/github/{%= repository %}/master.svg
[david-url]: https://david-dm.org/{%= repository %}
[david-img]: https://img.shields.io/david/{%= repository %}.svg
[standard-url]: https://github.com/feross/standard
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[paypalme-url]: https://www.paypal.me/tunnckoCore
[paypalme-img]: https://img.shields.io/badge/paypal-donate-brightgreen.svg