diff options
Diffstat (limited to 'node_modules/filename-regex/README.md')
| -rw-r--r-- | node_modules/filename-regex/README.md | 48 |
1 files changed, 30 insertions, 18 deletions
diff --git a/node_modules/filename-regex/README.md b/node_modules/filename-regex/README.md index d001e7aae..2b6b06999 100644 --- a/node_modules/filename-regex/README.md +++ b/node_modules/filename-regex/README.md @@ -1,12 +1,13 @@ -# filename-regex [](http://badge.fury.io/js/filename-regex) +# filename-regex [](https://www.npmjs.com/package/filename-regex) [](https://npmjs.org/package/filename-regex) [](https://npmjs.org/package/filename-regex) [](https://travis-ci.org/regexhq/filename-regex) > Regular expression for matching file names, with or without extension. +## Install -## Install with [npm](npmjs.org) +Install with [npm](https://www.npmjs.com/): -```bash -npm i filename-regex --save +```sh +$ npm install --save filename-regex ``` ## Usage @@ -21,31 +22,42 @@ var regex = require('filename-regex'); //=> match[0] = '.dotfile' ``` +## About -## Run tests +### Contributing -Install dev dependencies: +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). -```bash -npm i -d && npm test +### Building docs + +_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ + +To generate the readme, run the following command: + +```sh +$ npm install -g verbose/verb#dev verb-generate-readme && verb ``` -## Contributing -Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/regexps/filename-regex/issues) +### Running tests +Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: -## Author +```sh +$ npm install && npm test +``` + +### Author **Jon Schlinkert** - -+ [github/jonschlinkert](https://github.com/jonschlinkert) -+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert) +* [github/jonschlinkert](https://github.com/jonschlinkert) +* [twitter/jonschlinkert](https://twitter.com/jonschlinkert) + +### License -## License -Copyright (c) 2015 Jon Schlinkert -Released under the MIT license +Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert). +Released under the [MIT License](LICENSE). *** -_This file was generated by [verb](https://github.com/assemble/verb) on January 24, 2015._ +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on April 28, 2017._
\ No newline at end of file |