Skip to content

Commit 4632aca

Browse files
committed
update verb, docs
1 parent 64dd8a6 commit 4632aca

File tree

3 files changed

+57
-47
lines changed

3 files changed

+57
-47
lines changed

.verb.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
# {%= name %} {%= badge("fury") %} {%= badge("travis") %}
2-
3-
> {%= description %}
4-
5-
## Install
6-
{%= include("install-npm", {save: true}) %}
7-
81
## Usage
92

103
```js
@@ -20,23 +13,3 @@ var matches = str.match(regex());
2013
// matches[4] => '2016'
2114
// matches[5] => 'Jon Schlinkert'
2215
```
23-
24-
## Related projects
25-
{%= related(verb.related.list) %}
26-
27-
## Running tests
28-
{%= include("tests") %}
29-
30-
## Contributing
31-
{%= include("contributing") %}
32-
33-
## Authors
34-
{%= include("author") %}
35-
36-
## License
37-
{%= copyright() %}
38-
{%= license %}
39-
40-
***
41-
42-
{%= include("footer") %}

README.md

Lines changed: 34 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# copyright-regex [![NPM version](https://badge.fury.io/js/copyright-regex.svg)](http://badge.fury.io/js/copyright-regex)
1+
# copyright-regex [![NPM version](https://img.shields.io/npm/v/copyright-regex.svg?style=flat)](https://www.npmjs.com/package/copyright-regex) [![NPM monthly downloads](https://img.shields.io/npm/dm/copyright-regex.svg?style=flat)](https://npmjs.org/package/copyright-regex) [![NPM total downloads](https://img.shields.io/npm/dt/copyright-regex.svg?style=flat)](https://npmjs.org/package/copyright-regex) [![Linux Build Status](https://img.shields.io/travis/regexhq/copyright-regex.svg?style=flat&label=Travis)](https://travis-ci.org/regexhq/copyright-regex)
22

33
> Regex for matching and parsing copyright statements.
44
55
## Install
66

7-
Install with [npm](https://www.npmjs.com/)
7+
Install with [npm](https://www.npmjs.com/):
88

99
```sh
10-
$ npm i copyright-regex --save
10+
$ npm install --save copyright-regex
1111
```
1212

1313
## Usage
@@ -26,35 +26,51 @@ var matches = str.match(regex());
2626
// matches[5] => 'Jon Schlinkert'
2727
```
2828

29-
## Related projects
29+
## About
3030

31-
* [parse-copyright](https://github.com/jonschlinkert/parse-copyright): Parse copyright statement(s) into an array of copyright objects.
32-
* [update-copyright](https://github.com/jonschlinkert/update-copyright): Update the copyright statement in a string based on globally stored template and values.
31+
### Contributing
3332

34-
## Running tests
33+
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
3534

36-
Install dev dependencies:
35+
### Contributors
36+
37+
| **Commits** | **Contributor**<br/> |
38+
| --- | --- |
39+
| 18 | [jonschlinkert](https://github.com/jonschlinkert) |
40+
| 1 | [arthurvr](https://github.com/arthurvr) |
41+
| 1 | [tunnckoCore](https://github.com/tunnckoCore) |
42+
| 1 | [pdehaan](https://github.com/pdehaan) |
43+
44+
### Building docs
45+
46+
_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
47+
48+
To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
3749

3850
```sh
39-
$ npm i -d && npm test
51+
$ npm install -g verb verb-generate-readme && verb
4052
```
4153

42-
## Contributing
54+
### Running tests
4355

44-
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/regexps/copyright-regex/issues/new)
56+
Install dev dependencies:
57+
58+
```sh
59+
$ npm install -d && npm test
60+
```
4561

46-
## Authors
62+
### Author
4763

4864
**Jon Schlinkert**
4965

50-
+ [github/jonschlinkert](https://github.com/jonschlinkert)
51-
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
66+
* [github/regexhq](https://github.com/regexhq)
67+
* [twitter/regexhq](http://twitter.com/regexhq)
5268

53-
## License
69+
### License
5470

55-
Copyright © 2015 Jon Schlinkert
56-
Released under the MIT license.
71+
Copyright © 2016, [Jon Schlinkert](https://github.com/regexhq).
72+
Released under the [MIT license](https://github.com/regexhq/copyright-regex/blob/master/LICENSE).
5773

5874
***
5975

60-
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on May 25, 2015._
76+
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on December 07, 2016._

package.json

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
"test": "mocha"
2121
},
2222
"devDependencies": {
23+
"gulp-format-md": "^0.1.11",
2324
"mocha": "^3.2.0"
2425
},
2526
"keywords": [
@@ -31,5 +32,25 @@
3132
"regexp",
3233
"regular",
3334
"year"
34-
]
35-
}
35+
],
36+
"verb": {
37+
"toc": false,
38+
"layout": "default",
39+
"tasks": [
40+
"readme"
41+
],
42+
"plugins": [
43+
"gulp-format-md"
44+
],
45+
"lint": {
46+
"reflinks": true
47+
},
48+
"related": {
49+
"list": []
50+
},
51+
"reflinks": [
52+
"verb",
53+
"verb-generate-readme"
54+
]
55+
}
56+
}

0 commit comments

Comments
 (0)