From 8eac72b9d00278f95bcd0df161225d2b6810c68a Mon Sep 17 00:00:00 2001 From: "David Humphrey (:humph) david.humphrey@senecacollege.ca" Date: Wed, 19 Feb 2014 15:32:01 -0500 Subject: [PATCH] More README fixes --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fc05724..39188b4 100644 --- a/README.md +++ b/README.md @@ -1064,9 +1064,10 @@ sh.ls('/dir', { recursive: true }, function(err, entries) { #### sh.exec(path, [options], callback) -Attempts to execute the .js command located at `path`. Such commands -should be written so as to assume the existence of 3 global variables, -which will be defined at runtime: +Attempts to execute the .js command located at `path`. The `sh.exec` method +enables apps to install larger programs into the file system and run them +later without having to re-download. Such commands should be written so as +to assume the existence of 3 global variables, which will be defined at runtime: * `options` - an object containing any arguments, data, etc. * `fs` - the `FileSystem` object bound to this shell. * `callback` - a callback function of the form `function callback(error, result)` @@ -1104,8 +1105,9 @@ fs.writeFile('/cmd.js', cmd, callback(err) { Create a file if it does not exist, or update the access and modified times if it does. Valid options include: -* updateOnly - whether to create the file if it is missing (defaults to `false`) -* date - a date to use instead of the current date and time when updating +* `updateOnly` - `true` if the file's access/modified dates are to be updated +only (but missing file not to be) +* `date` - a date to use instead of the current date and time when updating access and modified dates. Example: