Browse files

[doc] Update

  • Loading branch information...
indexzero committed Aug 10, 2011
1 parent 178fd4f commit d432c5628de1981179f49b2c3a7982c43e7e484d
Showing with 13 additions and 0 deletions.
  1. +13 −0
@@ -20,6 +20,19 @@ node.js has good built in control for spawning child processes. `nexpect` builds
## Usage
+### Basic usage
+The core method, `nexpect.spawn(command, [params], [options])`, takes three parameters:
+* command: The command that you wish to spawn
+* params: The argv that you want to pass to the child process
+* options: An object literal which may contain
+ - verbose: Writes the stdout for the child process to `process.stdout` of the current process.
+ - stripColors: Strips any ANSI colors from the output for `.expect()` and `.wait()` statements.
+ - ignoreCase: Ignores the case of any output from the child process.
+Lets take a look at some sample usage:
``` js
var nexpect = require('nexpect');

0 comments on commit d432c56

Please sign in to comment.