aboutsummaryrefslogtreecommitdiff
path: root/node_modules/path-root/README.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2016-10-10 03:43:44 +0200
committerFlorian Dold <florian.dold@gmail.com>2016-10-10 03:43:44 +0200
commitabd94a7f5a50f43c797a11b53549ae48fff667c3 (patch)
treeab8ed457f65cdd72e13e0571d2975729428f1551 /node_modules/path-root/README.md
parenta0247c6a3fd6a09a41a7e35a3441324c4dcb58be (diff)
add node_modules to address #4364
Diffstat (limited to 'node_modules/path-root/README.md')
-rw-r--r--node_modules/path-root/README.md94
1 files changed, 94 insertions, 0 deletions
diff --git a/node_modules/path-root/README.md b/node_modules/path-root/README.md
new file mode 100644
index 000000000..aa3c86166
--- /dev/null
+++ b/node_modules/path-root/README.md
@@ -0,0 +1,94 @@
+# path-root [![NPM version](https://img.shields.io/npm/v/path-root.svg?style=flat)](https://www.npmjs.com/package/path-root) [![NPM downloads](https://img.shields.io/npm/dm/path-root.svg?style=flat)](https://npmjs.org/package/path-root) [![Build Status](https://img.shields.io/travis/jonschlinkert/path-root.svg?style=flat)](https://travis-ci.org/jonschlinkert/path-root)
+
+> Get the root of a posix or windows filepath.
+
+You might also be interested in [parse-filepath](https://github.com/jonschlinkert/parse-filepath).
+
+## Install
+
+Install with [npm](https://www.npmjs.com/):
+
+```sh
+$ npm install path-root --save
+```
+
+## Usage
+
+```js
+var pathRoot = require('path-root');
+```
+
+**Examples**
+
+```js
+pathRoot('\\\\server\\share\\abc');
+//=> '\\\\server\\share\\'
+
+pathRoot('\\\\server foo\\some folder\\base-file.js');
+//=> '\\\\server foo\\some folder\\'
+
+pathRoot('\\\\?\\UNC\\server\\share');
+//=> '\\\\?\\UNC\\'
+
+pathRoot('foo/bar/baz.js');
+//=> ''
+
+pathRoot('c:\\foo\\bar\\baz.js');
+//=> 'c:\\'
+
+pathRoot('\\\\slslslsl\\admin$\\system32');
+//=> '\\\\slslslsl\\admin$\\'
+
+pathRoot('/foo/bar/baz.js');
+//=> '/'
+```
+
+## Related projects
+
+You might also be interested in these projects:
+
+* [is-absolute](https://www.npmjs.com/package/is-absolute): Polyfill for node.js `path.isAbolute`. Returns true if a file path is absolute. | [homepage](https://github.com/jonschlinkert/is-absolute)
+* [parse-filepath](https://www.npmjs.com/package/parse-filepath): Parse a filepath into an object. Falls back on the native node.js `path.parse` method if… [more](https://www.npmjs.com/package/parse-filepath) | [homepage](https://github.com/jonschlinkert/parse-filepath)
+* [path-root-regex](https://www.npmjs.com/package/path-root-regex): Regular expression for getting the root of a posix or windows filepath. | [homepage](https://github.com/regexhq/path-root-regex)
+
+## Contributing
+
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/path-root/issues/new).
+
+## Building docs
+
+Generate readme and API documentation with [verb](https://github.com/verbose/verb):
+
+```sh
+$ npm install verb && npm run docs
+```
+
+Or, if [verb](https://github.com/verbose/verb) is installed globally:
+
+```sh
+$ verb
+```
+
+## Running tests
+
+Install dev dependencies:
+
+```sh
+$ npm install -d && npm test
+```
+
+## Author
+
+**Jon Schlinkert**
+
+* [github/jonschlinkert](https://github.com/jonschlinkert)
+* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
+
+## License
+
+Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
+Released under the [MIT license](https://github.com/jonschlinkert/path-root/blob/master/LICENSE).
+
+***
+
+_This file was generated by [verb](https://github.com/verbose/verb), v, on March 29, 2016._ \ No newline at end of file