Skip to content
This repository was archived by the owner on Feb 8, 2020. It is now read-only.

Commit 53494d9

Browse files
author
tunnckoCore
committed
docs(*): update readme, description and site url
1 parent d85a25b commit 53494d9

File tree

5 files changed

+60
-33
lines changed

5 files changed

+60
-33
lines changed

.verb.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
1-
# {%= name %} {%= badge('npm') %} {%= badge('downloads') %} [![npm total downloads][downloads-img]][downloads-url]
1+
<h1 align="center">{%= name %}
2+
<a href="https://www.npmjs.com/package/{%= name %}"><img src="https://img.shields.io/npm/v/{%= name %}.svg" alt="npm version"></a>
3+
<a href="https://www.npmjs.com/package/{%= name %}"><img src="https://img.shields.io/npm/l/{%= name %}.svg" alt="npm version"></a>
4+
<a href="https://www.npmjs.com/package/{%= name %}"><img src="https://img.shields.io/npm/dm/{%= name %}.svg" alt="npm downloads monthly"></a>
5+
<a href="https://www.npmjs.com/package/{%= name %}"><img src="https://img.shields.io/npm/dt/{%= name %}.svg" alt="npm downloads total"></a>
6+
<br>
7+
<img src="https://cdn.jsdelivr.net/emojione/assets/svg/1f54e.svg" width="256" height="256" alt="Parse a function"><br>
8+
Parse a function into an object
9+
</h1>
210

311
> {%= description %}
412
5-
[![code climate][codeclimate-img]][codeclimate-url]
6-
[![standard code style][standard-img]][standard-url]
7-
[![linux build status][travis-img]][travis-url]
8-
[![windows build status][appveyor-img]][appveyor-url]
9-
[![coverage status][coveralls-img]][coveralls-url]
13+
[![codeclimate][codeclimate-img]][codeclimate-url]
14+
[![codestyle][standard-img]][standard-url]
15+
[![linux build][travis-img]][travis-url]
16+
[![windows build][appveyor-img]][appveyor-url]
17+
[![codecov][coverage-img]][coverage-url]
1018
[![dependency status][david-img]][david-url]
1119

1220
{%= include('highlight') %}
@@ -105,12 +113,16 @@ $ npm install && npm test
105113
{%= includeEither('authors', 'author') %}
106114
+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)
107115

116+
## Logo
117+
The logo is [Menorah with nine branches Emoji](https://cdn.jsdelivr.net/emojione/assets/svg/1f54e.svg) from [EmojiOne.com](http://emojione.com/). Released under the [CC BY 4.0](http://emojione.com/licensing/) license.
118+
108119
## License
109-
{%= copyright({ start: 2016, linkify: true, prefix: 'Copyright', symbol: '©' }) %} {%= license %}
120+
{%= copyright({ start: 2015, linkify: true, prefix: 'Copyright', symbol: '©' }) %} {%= licenseStatement %}
110121

111122
***
112123

113-
{%= include('footer') %}
124+
{%= include('footer') %}
125+
_Project scaffolded using [charlike][] cli._
114126

115127
{%= reflinks(verb.reflinks) %}
116128

@@ -126,8 +138,8 @@ $ npm install && npm test
126138
[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/{%= name %}
127139
[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/{%= name %}/master.svg?label=windows
128140

129-
[coveralls-url]: https://coveralls.io/r/{%= repository %}
130-
[coveralls-img]: https://img.shields.io/coveralls/{%= repository %}.svg
141+
[coverage-url]: https://codecov.io/gh/{%= repository %}
142+
[coverage-img]: https://img.shields.io/codecov/c/github/{%= repository %}/master.svg
131143

132144
[david-url]: https://david-dm.org/{%= repository %}
133145
[david-img]: https://img.shields.io/david/{%= repository %}.svg

README.md

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
1-
# parse-function [![NPM version](https://img.shields.io/npm/v/parse-function.svg?style=flat)](https://www.npmjs.com/package/parse-function) [![NPM downloads](https://img.shields.io/npm/dm/parse-function.svg?style=flat)](https://npmjs.org/package/parse-function) [![npm total downloads][downloads-img]][downloads-url]
2-
3-
> Parse a function to an object that has its name, body, args and few more useful properties. Support regular functions, async/await, arrow and generator functions.
4-
5-
[![code climate][codeclimate-img]][codeclimate-url]
6-
[![standard code style][standard-img]][standard-url]
7-
[![linux build status][travis-img]][travis-url]
8-
[![windows build status][appveyor-img]][appveyor-url]
9-
[![coverage status][coveralls-img]][coveralls-url]
1+
<h1 align="center">parse-function
2+
<a href="https://www.npmjs.com/package/parse-function"><img src="https://img.shields.io/npm/v/parse-function.svg" alt="npm version"></a>
3+
<a href="https://www.npmjs.com/package/parse-function"><img src="https://img.shields.io/npm/l/parse-function.svg" alt="npm version"></a>
4+
<a href="https://www.npmjs.com/package/parse-function"><img src="https://img.shields.io/npm/dm/parse-function.svg" alt="npm downloads monthly"></a>
5+
<a href="https://www.npmjs.com/package/parse-function"><img src="https://img.shields.io/npm/dt/parse-function.svg" alt="npm downloads total"></a>
6+
<br>
7+
<img src="https://cdn.jsdelivr.net/emojione/assets/svg/1f54e.svg" width="256" height="256" alt="Parse a function"><br>
8+
Parse a function into an object
9+
</h1>
10+
11+
> Parse a function into an object that has its name, body, args and a few more useful properties.
12+
13+
[![codeclimate][codeclimate-img]][codeclimate-url]
14+
[![codestyle][standard-img]][standard-url]
15+
[![linux build][travis-img]][travis-url]
16+
[![windows build][appveyor-img]][appveyor-url]
17+
[![codecov][coverage-img]][coverage-url]
1018
[![dependency status][david-img]][david-url]
1119

1220
## Pro Tips (What version to use?)
@@ -30,10 +38,9 @@ Run the benchamrks to see the diffs. The `v2.0.x` is the fastest one, but it has
3038
- [Building docs](#building-docs)
3139
- [Running tests](#running-tests)
3240
- [Author](#author)
41+
- [Logo](#logo)
3342
- [License](#license)
3443

35-
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
36-
3744
## Install
3845
Install with [npm](https://www.npmjs.com/)
3946

@@ -56,7 +63,7 @@ const parseFunction = require('parse-function')
5663

5764
## API
5865

59-
### [parseFunction](index.js#L82)
66+
### [parseFunction](index.js#L83)
6067
> Parse a function or string that contains a function, using [babylon][] or [acorn][] parsers. By default it uses `babylon`, but you can pass custom one through `options.parse` option - for example pass `.parse: acorn.parse` to force use the `acorn` parser instead.
6168
6269
**Params**
@@ -184,21 +191,26 @@ $ npm install && npm test
184191
**Charlike Mike Reagent**
185192

186193
+ [github/tunnckoCore](https://github.com/tunnckoCore)
187-
+ [twitter/tunnckoCore](http://twitter.com/tunnckoCore)
194+
+ [twitter/tunnckoCore](https://twitter.com/tunnckoCore)
188195
+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)
189196

197+
## Logo
198+
The logo is [Menorah with nine branches Emoji](https://cdn.jsdelivr.net/emojione/assets/svg/1f54e.svg) from [EmojiOne.com](http://emojione.com/). Released under the [CC BY 4.0](http://emojione.com/licensing/) license.
199+
190200
## License
191-
Copyright © 2016, [Charlike Mike Reagent](http://i.am.charlike.online). Released under the [MIT license](LICENSE).
201+
Copyright © 2015, 2017, [Charlike Mike Reagent](https://i.am.charlike.online). Released under the [MIT License](LICENSE).
192202

193203
***
194204

195-
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on December 10, 2016._
205+
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on March 07, 2017._
206+
_Project scaffolded using [charlike][] cli._
196207

197208
[acorn]: https://github.com/ternjs/acorn
198209
[always-done]: https://github.com/hybridables/always-done
199210
[async-done]: https://github.com/gulpjs/async-done
200211
[babylon]: https://babeljs.io/
201212
[base]: https://github.com/node-base/base
213+
[charlike]: https://github.com/tunnckocore/charlike
202214
[commitizen]: https://github.com/commitizen/cz-cli
203215
[dezalgo]: https://github.com/npm/dezalgo
204216
[once]: https://github.com/isaacs/once
@@ -218,8 +230,8 @@ _This file was generated by [verb-generate-readme](https://github.com/verbose/ve
218230
[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/parse-function
219231
[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/parse-function/master.svg?label=windows
220232

221-
[coveralls-url]: https://coveralls.io/r/tunnckoCore/parse-function
222-
[coveralls-img]: https://img.shields.io/coveralls/tunnckoCore/parse-function.svg
233+
[coverage-url]: https://codecov.io/gh/tunnckoCore/parse-function
234+
[coverage-img]: https://img.shields.io/codecov/c/github/tunnckoCore/parse-function/master.svg
223235

224236
[david-url]: https://david-dm.org/tunnckoCore/parse-function
225237
[david-img]: https://img.shields.io/david/tunnckoCore/parse-function.svg

index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*!
22
* parse-function <https://github.com/tunnckoCore/parse-function>
33
*
4-
* Copyright (c) Charlike Mike Reagent <@tunnckoCore> (http://i.am.charlike.online)
4+
* Copyright (c) Charlike Mike Reagent <@tunnckoCore> (https://i.am.charlike.online)
55
* Released under the MIT license.
66
*/
77

package.json

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"name": "parse-function",
33
"version": "3.0.0",
4-
"description": "Parse a function to an object that has its name, body, args and few more useful properties. Support regular functions, async/await, arrow and generator functions.",
4+
"description": "Parse a function into an object that has its name, body, args and a few more useful properties.",
55
"repository": "tunnckoCore/parse-function",
6-
"author": "Charlike Mike Reagent <@tunnckoCore> (http://i.am.charlike.online)",
6+
"author": "Charlike Mike Reagent <@tunnckoCore> (https://i.am.charlike.online)",
77
"precommit.silent": true,
88
"main": "index.js",
99
"license": "MIT",
@@ -104,17 +104,20 @@
104104
]
105105
},
106106
"reflinks": [
107+
"acorn",
107108
"always-done",
108109
"async-done",
110+
"babylon",
109111
"base",
110112
"commitizen",
111113
"dezalgo",
112114
"once",
113115
"standard-version",
114116
"verb",
115117
"verb-generate-readme",
116-
"acorn",
117-
"babylon"
118+
"charlike",
119+
"coveralls-img",
120+
"coveralls-url"
118121
],
119122
"lint": {
120123
"reflinks": true

test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*!
22
* parse-function <https://github.com/tunnckoCore/parse-function>
33
*
4-
* Copyright (c) Charlike Mike Reagent <@tunnckoCore> (http://i.am.charlike.online)
4+
* Copyright (c) Charlike Mike Reagent <@tunnckoCore> (https://i.am.charlike.online)
55
* Released under the MIT license.
66
*/
77

0 commit comments

Comments
 (0)