From f163c812cdc6a9a9b773ab76af457e1f7ad5b757 Mon Sep 17 00:00:00 2001 From: Joran Dirk Greef Date: Thu, 26 Nov 2015 12:12:30 +0200 Subject: [PATCH] Document stdout and stderr arguments to callback in usage example --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a0f9a9..6c112ab 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ var options = { icns: '/path/to/icns/file', // (optional) onChildProcess: function(childProcess) {} // (optional) }; -sudo.exec('echo hello', options, function(error) {}); +sudo.exec('echo hello', options, function(error, stdout, stderr) {}); ``` `sudo-prompt` will use `process.title` as `options.name` if `options.name` is not provided. `options.name` must be alphanumeric only (spaces are supported) and at most 70 characters.