From 340f72d29020e0bc8a0c3d3a58013a8538216ce5 Mon Sep 17 00:00:00 2001 From: anseki Date: Wed, 25 Mar 2015 16:07:19 +0900 Subject: [PATCH] Small change README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 267b19b..c216bc6 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ readlineSync.setPrint(function(display, encoding) { currentMask = readlineSync.setMask([newMask]) ``` -Set the mask character that is shown instead of the secret text (e.g. password). (See `noEchoBack` option.) The default is `'*'`. If you want to show nothing, specify `''`. (But it might be not user friendly in some cases.) +Set the mask character that is shown instead of the secret text (e.g. password) when `noEchoBack` option is `true`. (See `noEchoBack` option.) The default is `'*'`. If you want to show nothing, specify `''`. (But it might be not user friendly in some cases.) *Note:* The some platforms might use `'*'` or `''` always. For example: @@ -157,7 +157,7 @@ An `options` Object can be specified to `prompt` method and `question` method. T Type: Boolean Default: `false` -If `true` is specified, echo back is avoided. It is used to hide the secret text (e.g. password) which is typed by user on screen. (See `setMask` method) +If `true` is specified, the secret text (e.g. password) which is typed by user on screen is hidden by the mask characters. (See `setMask` method) For example: