|
1 |
| -# [{%= name %}][author-www-url] [![npmjs.com][npmjs-img]][npmjs-url] [![The MIT License][license-img]][license-url] [![npm downloads][downloads-img]][downloads-url] |
| 1 | +# {%= name %} {%= badge('npm') %} [![mit license][license-img]][license-url] {%= badge('downloads') %} [![npm total downloads][downloads-img]][downloads-url] |
2 | 2 |
|
3 | 3 | > {%= description %}
|
4 | 4 |
|
5 |
| -[![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url] |
| 5 | +[![code climate][codeclimate-img]][codeclimate-url] |
| 6 | +[![code style][standard-img]][standard-url] |
| 7 | +[![linux build][travis-img]][travis-url] |
| 8 | +[![windows build][appveyor-img]][appveyor-url] |
| 9 | +[![code coverage][coverage-img]][coverage-url] |
| 10 | +[![dependency status][david-img]][david-url] |
| 11 | +[![paypal donate][paypalme-img]][paypalme-url] |
| 12 | + |
| 13 | +{%= include('highlight') %} |
| 14 | + |
| 15 | +## Table of Contents |
| 16 | +<!-- toc --> |
6 | 17 |
|
7 | 18 | ## Install
|
8 |
| -> Install with [npm](https://www.npmjs.com/) |
| 19 | +Install with [npm](https://www.npmjs.com/) |
| 20 | + |
| 21 | +``` |
| 22 | +$ npm install {%= name %} --save |
| 23 | +``` |
| 24 | + |
| 25 | +or install using [yarn](https://yarnpkg.com) |
9 | 26 |
|
10 | 27 | ```
|
11 |
| -$ npm i {%= name %} --save |
| 28 | +$ yarn add {%= name %} |
12 | 29 | ```
|
13 | 30 |
|
14 | 31 | ## Usage
|
15 |
| -> For more use-cases see the [tests](./test.js) |
| 32 | +> For more use-cases see the [tests](test.js) |
16 | 33 |
|
17 | 34 | ```js
|
18 | 35 | const {%= varname %} = require('{%= name %}')
|
@@ -58,66 +75,80 @@ console.log(isAsyncFn(myAsyncFn, false)) // => false
|
58 | 75 | console.log(isAsyncFn(myAsyncFn, ['callback', 'qux'], false)) // => 1
|
59 | 76 | // you are getting "1", because `qux` is second item
|
60 | 77 | // in provided `names` array.
|
61 |
| -``` |
| 78 | +``` |
62 | 79 |
|
63 | 80 | {% if (verb.related && verb.related.list && verb.related.list.length) { %}
|
64 | 81 | ## Related
|
65 |
| -{%= related(verb.related.list, {words: 12}) %} |
| 82 | +{%= related(verb.related.list, {words: 20}) %} |
66 | 83 | {% } %}
|
67 | 84 |
|
68 | 85 | ## Contributing
|
69 | 86 | Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/{%= repository %}/issues/new).
|
70 |
| -But before doing anything, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines. |
| 87 | +Please read the [contributing guidelines](CONTRIBUTING.md) for advice on opening issues, pull requests, and coding standards. |
| 88 | +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. |
71 | 89 |
|
72 |
| -## [Charlike Make Reagent](http://j.mp/1stW47C) [![new message to charlike][new-message-img]][new-message-url] [![freenode #charlike][freenode-img]][freenode-url] |
| 90 | +**In short:** If you want to contribute to that project, please follow these things |
73 | 91 |
|
74 |
| -[![{%= author.username %}.tk][author-www-img]][author-www-url] [![keybase {%= author.username %}][keybase-img]][keybase-url] [![{%= author.username %} npm][author-npm-img]][author-npm-url] [![{%= author.username %} twitter][author-twitter-img]][author-twitter-url] [![{%= author.username %} github][author-github-img]][author-github-url] |
| 92 | +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. |
| 93 | +2. Ensure anything is okey by installing the dependencies and run the tests. See ["Running tests"](#running-tests) section. |
| 94 | +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. |
| 95 | +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. |
75 | 96 |
|
76 |
| -{%= reflinks(verb.reflinks) %} |
| 97 | +Thanks a lot! :) |
77 | 98 |
|
78 |
| -[npmjs-url]: https://www.npmjs.com/package/{%= name %} |
79 |
| -[npmjs-img]: https://img.shields.io/npm/v/{%= name %}.svg?label={%= name %} |
| 99 | +## Building docs |
| 100 | +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 |
| 101 | + |
| 102 | +``` |
| 103 | +$ npm install verbose/verb#dev verb-generate-readme --global && verb |
| 104 | +``` |
| 105 | + |
| 106 | +_Please don't edit the README directly. Any changes to the readme must be made in [.verb.md](.verb.md)._ |
| 107 | + |
| 108 | +## Running tests |
| 109 | +Clone repository and run the following in that cloned directory |
| 110 | + |
| 111 | +``` |
| 112 | +$ npm install && npm test |
| 113 | +``` |
80 | 114 |
|
81 |
| -[license-url]: https://github.com/{%= repository %}/blob/master/LICENSE |
| 115 | +## Author |
| 116 | +{%= includeEither('authors', 'author') %} |
| 117 | ++ [codementor/tunnckoCore](https://codementor.io/tunnckoCore) |
| 118 | + |
| 119 | +## License |
| 120 | +{%= copyright({ start: 2016, linkify: true, prefix: 'Copyright', symbol: '©' }) %} {%= licenseStatement %} |
| 121 | + |
| 122 | +*** |
| 123 | + |
| 124 | +{%= include('footer') %} |
| 125 | +_Project scaffolded using [charlike][] cli._ |
| 126 | + |
| 127 | +{%= reflinks(verb.reflinks) %} |
| 128 | + |
| 129 | +[license-url]: https://www.npmjs.com/package/{%= name %} |
82 | 130 | [license-img]: https://img.shields.io/npm/l/{%= name %}.svg
|
83 | 131 |
|
84 | 132 | [downloads-url]: https://www.npmjs.com/package/{%= name %}
|
85 |
| -[downloads-img]: https://img.shields.io/npm/dm/{%= name %}.svg |
86 |
| - |
| 133 | +[downloads-img]: https://img.shields.io/npm/dt/{%= name %}.svg |
87 | 134 |
|
88 | 135 | [codeclimate-url]: https://codeclimate.com/github/{%= repository %}
|
89 | 136 | [codeclimate-img]: https://img.shields.io/codeclimate/github/{%= repository %}.svg
|
90 | 137 |
|
91 | 138 | [travis-url]: https://travis-ci.org/{%= repository %}
|
92 |
| -[travis-img]: https://img.shields.io/travis/{%= repository %}/master.svg |
| 139 | +[travis-img]: https://img.shields.io/travis/{%= repository %}/master.svg?label=linux |
| 140 | + |
| 141 | +[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/{%= name %} |
| 142 | +[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/{%= name %}/master.svg?label=windows |
93 | 143 |
|
94 |
| -[coveralls-url]: https://coveralls.io/r/{%= repository %} |
95 |
| -[coveralls-img]: https://img.shields.io/coveralls/{%= repository %}.svg |
| 144 | +[coverage-url]: https://codecov.io/gh/{%= repository %} |
| 145 | +[coverage-img]: https://img.shields.io/codecov/c/github/{%= repository %}/master.svg |
96 | 146 |
|
97 | 147 | [david-url]: https://david-dm.org/{%= repository %}
|
98 | 148 | [david-img]: https://img.shields.io/david/{%= repository %}.svg
|
99 | 149 |
|
100 | 150 | [standard-url]: https://github.com/feross/standard
|
101 | 151 | [standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
|
102 | 152 |
|
103 |
| - |
104 |
| -[author-www-url]: http://www.{%= author.username.toLowerCase() %}.tk |
105 |
| -[author-www-img]: https://img.shields.io/badge/www-{%= author.username.toLowerCase() %}.tk-fe7d37.svg |
106 |
| - |
107 |
| -[keybase-url]: https://keybase.io/{%= author.username.toLowerCase() %} |
108 |
| -[keybase-img]: https://img.shields.io/badge/keybase-{%= author.username.toLowerCase() %}-8a7967.svg |
109 |
| - |
110 |
| -[author-npm-url]: https://www.npmjs.com/~{%= author.username.toLowerCase() %} |
111 |
| -[author-npm-img]: https://img.shields.io/badge/npm-~{%= author.username.toLowerCase() %}-cb3837.svg |
112 |
| - |
113 |
| -[author-twitter-url]: https://twitter.com/{%= author.username %} |
114 |
| -[author-twitter-img]: https://img.shields.io/badge/twitter-@{%= author.username %}-55acee.svg |
115 |
| - |
116 |
| -[author-github-url]: https://github.com/{%= author.username %} |
117 |
| -[author-github-img]: https://img.shields.io/badge/github-@{%= author.username %}-4183c4.svg |
118 |
| - |
119 |
| -[freenode-url]: http://webchat.freenode.net/?channels=charlike |
120 |
| -[freenode-img]: https://img.shields.io/badge/freenode-%23charlike-5654a4.svg |
121 |
| - |
122 |
| -[new-message-url]: https://github.com/{%= author.username %}/ama |
123 |
| -[new-message-img]: https://img.shields.io/badge/ask%20me-anything-green.svg |
| 153 | +[paypalme-url]: https://www.paypal.me/tunnckoCore |
| 154 | +[paypalme-img]: https://img.shields.io/badge/paypal-donate-brightgreen.svg |
0 commit comments