Skip to content
Browse files

document readline, delim

  • Loading branch information...
1 parent b7cba69 commit 31007c6c416a19a72e87c37d68913ffb85c606b4 @substack committed Jun 12, 2012
Showing with 8 additions and 0 deletions.
  1. +8 −0 README.markdown
View
8 README.markdown
@@ -52,6 +52,11 @@ document is used.
If `cb` is specified, use the return value of `cb(s)` for the string `s`
obtained from the user.
+readline(cb)
+------------
+
+Fetch a line from the input stream, including a trailing newline.
+
functions
---------
@@ -72,6 +77,9 @@ prompter(src, context={}, cb)
Evaluate the string source `src` under some optional `context`, calling
`cb(err, output)` with the completed file contents.
+Control the delimiter by passing in a value for `context.delim`, which defaults
+to `': '`.
+
Returns a readable/writable stream that should be pipe into and out of a user's
stdin/stdout.

0 comments on commit 31007c6

Please sign in to comment.
Something went wrong with that request. Please try again.