summaryrefslogtreecommitdiff
path: root/node_modules/author-regex/README.md
diff options
context:
space:
mode:
authorLinuxWizard42 <computerwizard@linuxmail.org>2022-10-12 22:54:37 +0300
committerLinuxWizard42 <computerwizard@linuxmail.org>2022-10-12 22:54:37 +0300
commit703e03aba33f234712206769f57717ba7d92d23d (patch)
tree0041f04ccb75bd5379c764e9fe42249fffe75fc3 /node_modules/author-regex/README.md
parentab6e257e6e9d9a483d7e86f220d8b209a2cd7753 (diff)
downloadFlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.gz
FlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.zst
Added export_allowed file to make repository visible in cgit
Diffstat (limited to 'node_modules/author-regex/README.md')
-rw-r--r--node_modules/author-regex/README.md69
1 files changed, 69 insertions, 0 deletions
diff --git a/node_modules/author-regex/README.md b/node_modules/author-regex/README.md
new file mode 100644
index 0000000..129534c
--- /dev/null
+++ b/node_modules/author-regex/README.md
@@ -0,0 +1,69 @@
+# author-regex [![NPM version](https://badge.fury.io/js/author-regex.svg)](http://badge.fury.io/js/author-regex)
+
+
+> Regular expression for parsing an `author` string into an object following npm conventions.
+
+This the regex used by [parse-authors](https://github.com/jonschlinkert/parse-authors).
+
+
+**Related**
+
+ - [parse-author](https://github.com/jonschlinkert/parse-author)
+ - [parse-authors](https://github.com/jonschlinkert/parse-authors)
+
+
+## Install
+#### Install with [npm](npmjs.org)
+
+```bash
+npm i author-regex --save
+```
+#### Install with [bower](https://github.com/bower/bower)
+
+```bash
+bower install author-regex --save
+```
+
+## Tests
+
+Run
+
+```bash
+npm test
+```
+
+## Usage
+
+```js
+var re = require('author-regex');
+
+function authors(str) {
+ return re().exec(str);
+}
+console.log(author('Jon Schlinkert <foo@bar.com> (https://github.com/jonschlinkert)'));
+```
+Returns:
+
+```js
+[ 'Jon Schlinkert <foo@bar.com> (https://github.com/jonschlinkert)',
+ 'Jon Schlinkert',
+ 'foo@bar.com',
+ 'https://github.com/jonschlinkert',
+ index: 0,
+ input: 'Jon Schlinkert <foo@bar.com> (https://github.com/jonschlinkert)' ]
+```
+
+## Author
+
+**Jon Schlinkert**
+
++ [github/jonschlinkert](https://github.com/jonschlinkert)
++ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
+
+## License
+Copyright (c) 2014 Jon Schlinkert, contributors.
+Released under the MIT license
+
+***
+
+_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on September 29, 2014._ \ No newline at end of file