summaryrefslogtreecommitdiffstats
path: root/node_modules/pkg-dir/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/pkg-dir/readme.md')
-rw-r--r--node_modules/pkg-dir/readme.md64
1 files changed, 0 insertions, 64 deletions
diff --git a/node_modules/pkg-dir/readme.md b/node_modules/pkg-dir/readme.md
deleted file mode 100644
index 3cab12e..0000000
--- a/node_modules/pkg-dir/readme.md
+++ /dev/null
@@ -1,64 +0,0 @@
-# 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 Node.js project or npm package
-
-
-## Install
-
-```
-$ npm install --save pkg-dir
-```
-
-
-## Usage
-
-```
-/
-└── Users
- └── sindresorhus
- └── foo
- ├── package.json
- └── bar
- ├── baz
- └── example.js
-```
-
-```js
-// example.js
-const pkgDir = require('pkg-dir');
-
-pkgDir(__dirname).then(rootDir => {
- console.log(rootDir);
- //=> '/Users/sindresorhus/foo'
-});
-```
-
-
-## API
-
-### pkgDir([cwd])
-
-Returns a `Promise` for either the project root path or `null` if it couldn't be found.
-
-### pkgDir.sync([cwd])
-
-Returns the project root path or `null`.
-
-#### cwd
-
-Type: `string`<br>
-Default: `process.cwd()`
-
-Directory to start from.
-
-
-## Related
-
-- [pkg-dir-cli](https://github.com/sindresorhus/pkg-dir-cli) - CLI for this module
-- [pkg-up](https://github.com/sindresorhus/pkg-up) - Find the closest package.json file
-- [find-up](https://github.com/sindresorhus/find-up) - Find a file by walking up parent directories
-
-
-## License
-
-MIT © [Sindre Sorhus](https://sindresorhus.com)