Skip to content

Commit

Permalink
document default
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacs committed Dec 9, 2011
1 parent 6cafa22 commit 8d72a84
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Expand Up @@ -20,6 +20,7 @@ Every option is optional.
* `num` Max number of chars to read from terminal.
* `delim` The char that means we're done. Default: `"\n"`
* `timeout` Number of ms to wait for user input before giving up.
* `default` The default value if the user enters nothing.

If silent is true, or num is set, or delim is something other than
`"\n"`, then read will set raw mode, and read character by character.
Expand Down

0 comments on commit 8d72a84

Please sign in to comment.