aboutsummaryrefslogtreecommitdiff
path: root/node_modules/pkg-dir/readme.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-05-28 00:38:50 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-05-28 00:40:43 +0200
commit7fff4499fd915bcea3fa93b1aa8b35f4fe7a6027 (patch)
tree6de9a1aebd150a23b7f8c273ec657a5d0a18fe3e /node_modules/pkg-dir/readme.md
parent963b7a41feb29cc4be090a2446bdfe0c1f1bcd81 (diff)
add linting (and some initial fixes)
Diffstat (limited to 'node_modules/pkg-dir/readme.md')
-rw-r--r--node_modules/pkg-dir/readme.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/node_modules/pkg-dir/readme.md b/node_modules/pkg-dir/readme.md
new file mode 100644
index 000000000..82bb83517
--- /dev/null
+++ b/node_modules/pkg-dir/readme.md
@@ -0,0 +1,63 @@
+# pkg-dir [![Build Status](https://travis-ci.org/sindresorhus/pkg-dir.svg?branch=master)](https://travis-ci.org/sindresorhus/pkg-dir)
+
+> Find the root directory of a npm package
+
+
+## Install
+
+```
+$ npm install --save pkg-dir
+```
+
+
+## Usage
+
+```
+/
+└── Users
+ └── sindresorhus
+ └── foo
+ ├── package.json
+ └── bar
+ ├── baz
+ └── example.js
+```
+
+```js
+// example.js
+var pkgDir = require('pkg-dir');
+
+pkgDir(__dirname).then(function (rootPath) {
+ console.log(rootPath);
+ //=> '/Users/sindresorhus/foo'
+});
+```
+
+
+## API
+
+### pkgDir([cwd])
+
+Returns a promise that resolves to the package root path or `null`.
+
+### pkgDir.sync([cwd])
+
+Returns the package root path or `null`.
+
+#### cwd
+
+Type: `string`
+Default: `process.cwd()`
+
+Directory to start from.
+
+
+## Related
+
+- [pkg-dir-cli](https://github.com/sindresorhus/pkg-dir-cli) - CLI for this module
+- [find-up](https://github.com/sindresorhus/find-up) - Find a file by walking up parent directories
+
+
+## License
+
+MIT © [Sindre Sorhus](http://sindresorhus.com)