summaryrefslogtreecommitdiffstats
path: root/node_modules/commondir/readme.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/commondir/readme.markdown')
-rw-r--r--node_modules/commondir/readme.markdown48
1 files changed, 48 insertions, 0 deletions
diff --git a/node_modules/commondir/readme.markdown b/node_modules/commondir/readme.markdown
new file mode 100644
index 0000000..6c20607
--- /dev/null
+++ b/node_modules/commondir/readme.markdown
@@ -0,0 +1,48 @@
+# commondir
+
+compute the closest common parent directory among an array of directories
+
+# example
+
+``` js
+var commondir = require('commondir');
+var dir = commondir(process.argv.slice(2))
+console.log(dir);
+```
+
+output:
+
+```
+$ node dir.js /x/y/z /x/y /x/y/w/q
+/x/y
+$ node ../baz ../../foo/quux ./bizzy
+/foo
+```
+
+# methods
+
+``` js
+var commondir = require('commondir');
+```
+
+## commondir(absolutePaths)
+
+Compute the closest common parent directory for an array `absolutePaths`.
+
+## commondir(basedir, relativePaths)
+
+Compute the closest common parent directory for an array `relativePaths` which
+will be resolved for each `dir` in `relativePaths` according to:
+`path.resolve(basedir, dir)`.
+
+# install
+
+With [npm](https://npmjs.org) do:
+
+```
+npm install commondir
+```
+
+# license
+
+MIT