From edb9caa91e57690ddaace09aafb863f5bbac3ed8 Mon Sep 17 00:00:00 2001 From: Trey Shugart Date: Thu, 12 Nov 2015 13:23:28 +1100 Subject: [PATCH] #129 - Update documentation to more clearly explain what happens for default base option values. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a485cf86..d721f46a 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,8 @@ fs.src(['*.js', '!b*.js']) - Default is `process.cwd()`. - base - Specify the folder relative to the cwd. This is used to determine the file names when saving in `.dest()`. - - Default is where the glob begins if any. - - Default is `process.cwd()` if there is no glob. + - Default is where the glob begins, if any. For example, `path/to/**/*.js` would resolve to `path/to`. + - If there is no glob (i.e. a file path with no pattern), then the dirname of the path is used. For example, `path/to/some/file.js` would resolve to `path/to/some`. - buffer - `true` or `false` if you want to buffer the file. - Default value is `true`.