Skip to content

Commit e3cb645

Browse files
committed
update readme
1 parent 0b0a44e commit e3cb645

File tree

2 files changed

+29
-25
lines changed

2 files changed

+29
-25
lines changed

.verb.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
> {%= description %}
44
5+
## Install
56
{%= include("install-npm", {save: true}) %}
67

78
## Usage
@@ -20,28 +21,22 @@ var matches = str.match(regex());
2021
// matches[5] => 'Jon Schlinkert'
2122
```
2223

23-
## Run tests
24+
## Related projects
25+
{%= related(['update-copyright', 'parse-copyright']) %}
2426

25-
Install dev dependencies:
26-
27-
```bash
28-
npm i -d && npm test
29-
```
27+
## Running tests
28+
{%= include("tests") %}
3029

3130
## Contributing
32-
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue]({%= bugs.url %})
33-
34-
## Author
35-
36-
**Jon Schlinkert**
31+
{%= include("contributing") %}
3732

38-
+ [github/jonschlinkert](https://github.com/jonschlinkert)
39-
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
33+
## Authors
34+
{%= include("author") %}
4035

4136
## License
4237
{%= copyright() %}
4338
{%= license() %}
4439

4540
***
4641

47-
{%= include("footer") %}
42+
{%= include("footer") %}

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
> Regex for matching and parsing copyright statements.
44
5-
## Install with [npm](npmjs.org)
5+
## Install
66

7-
```bash
8-
npm i copyright-regex --save
7+
Install with [npm](https://www.npmjs.com/)
8+
9+
```sh
10+
$ npm i copyright-regex --save
911
```
1012

1113
## Usage
@@ -24,28 +26,35 @@ var matches = str.match(regex());
2426
// matches[5] => 'Jon Schlinkert'
2527
```
2628

27-
## Run tests
29+
## Related projects
30+
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.
33+
34+
## Running tests
2835

2936
Install dev dependencies:
3037

31-
```bash
32-
npm i -d && npm test
38+
```sh
39+
$ npm i -d && npm test
3340
```
3441

3542
## Contributing
36-
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/regexps/copyright-regex/issues)
3743

38-
## Author
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)
45+
46+
## Authors
3947

4048
**Jon Schlinkert**
4149

4250
+ [github/jonschlinkert](https://github.com/jonschlinkert)
4351
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
4452

4553
## License
46-
Copyright (c) 2015 Jon Schlinkert
47-
Released under the MIT license
54+
55+
Copyright © 2015 Jon Schlinkert
56+
Released under the MIT license.
4857

4958
***
5059

51-
_This file was generated by [verb](https://github.com/assemble/verb) on February 01, 2015._
60+
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on May 25, 2015._

0 commit comments

Comments
 (0)