From ee91dde91c89daa300c2c5ccbd9cffcd90597bb9 Mon Sep 17 00:00:00 2001 From: JP Richardson Date: Mon, 14 Oct 2013 08:59:56 -0500 Subject: [PATCH] update readme to reflect `filter` for copy() and `options` for {read,write}Json. --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b2c0355..9d543ce 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ Methods **NOTE:** You can still use the native Node.js methods. They are copied over to `fs-extra`. -### copy(src, dest, callback) +### copy(src, dest, [filter], callback) Copy a file or directory. The directory can have contents. Like `cp -r`. There isn't a synchronous version implemented yet. @@ -185,9 +185,9 @@ fs.outputJson(file, {name: 'JP'}, function(err) { -### readJson(file, callback) +### readJson(file, [options], callback) -Reads a JSON file and then parses it into an object. +Reads a JSON file and then parses it into an object. `options` are the same that you'd pass to `fs.readFile`. Alias: `readJSON()` @@ -230,9 +230,9 @@ fs.removeSync('/home/jprichardson'); //I just deleted my entire HOME directory. -### writeJson(file, object, callback) +### writeJson(file, object, [options], callback) -Writes an object to a JSON file. +Writes an object to a JSON file. `options` are the same that you'd pass to `fs.readFile`. Alias: `writeJSON()`