[Pkg-javascript-commits] [node-parents] 06/29: readme

[Bastien Roucariès]

This is an automated email from the git hooks/post-receive script.

rouca pushed a commit to branch master
in repository node-parents.

commit da18c147076fbd1880180f026ca48a12f352f7b6
Author: James Halliday <mail at substack.net>
Date:   Thu Jul 12 01:42:33 2012 -0700

    readme
---
 readme.markdown | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 73 insertions(+)

diff --git a/readme.markdown b/readme.markdown
new file mode 100644
index 0000000..6896eb7
--- /dev/null
+++ b/readme.markdown
@@ -0,0 +1,73 @@
+# parents
+
+Return all the parent directories of a directory, inclusive of that directory.
+
+# example
+
+## dirname
+
+``` js
+var parents = require('parents');
+var dirs = parents(__dirname);
+console.dir(dirs);
+```
+
+***
+
+```
+[ '/home/substack/projects/node-parents/example',
+  '/home/substack/projects/node-parents',
+  '/home/substack/projects',
+  '/home/substack',
+  '/home',
+  '/' ]
+```
+
+## win32
+
+``` js
+var parents = require('parents');
+var dir = 'C:\\Program Files\\Maxis\\Sim City 2000\\cities';
+
+var dirs = parents(dir, { platform : 'win32' });
+console.dir(dirs);
+```
+
+***
+
+```
+[ 'C:\\Program Files\\Maxis\\Sim City 2000\\cities',
+  'C:\\Program Files\\Maxis\\Sim City 2000',
+  'C:\\Program Files\\Maxis',
+  'C:\\Program Files',
+  'C:' ]
+```
+
+# methods
+
+``` js
+var parents = require('parents')
+```
+
+## parents(dir, opts)
+
+Return an array of the parent directories of `dir`, including and starting with
+`dir`. If a `dir` isn't specified, `process.cwd()` will be used.
+
+Optionally specify an `opts.platform` to control whether the separator and paths
+works the unixy way with `'/'` or the windowsy way where sometimes things use
+`'/'` and sometimes they use `'\\'` and also there are leading drive letters and
+other exotic features. If `opts.platform` isn't specified, `process.platform`
+will be used. Anything that matches `/^win/` will use the windowsy behavior.
+
+# install
+
+With [npm](http://npmjs.org) do:
+
+```
+npm install parents
+```
+
+# licence
+
+MIT

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-parents.git