From bb0f031683260a289383404d5aa16053ab6691b3 Mon Sep 17 00:00:00 2001 From: Fernando van Loenhout Date: Mon, 14 Oct 2019 21:27:56 +0200 Subject: [PATCH] Properly indent the list of options this makes the readme more readable from the github interface and the NPM overview Also properly indicate that the `ip` input type only acepts IPv4 addresses --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 501779e..31309ed 100644 --- a/README.md +++ b/README.md @@ -61,27 +61,27 @@ cli.parse({ Below is a list of the return types followed by a description and a list of valid values you can use for this option to get desired type of Object back. - **as-is:** What you enter, is what you get - - 'string', 1, true - - **int:** Is converted to an Integer wrapped in a Number Object - - 'int', 'number', 'num', - - 'time', 'seconds', 'secs', 'minutes', 'mins' - - 'x', 'n' - - **date:** Is converted to a Date Object - - 'date', 'datetime', 'date_time' + - 'string', 1, true + - **int:** Is converted to an Integer wrapped in a Number Object + - 'int', 'number', 'num', + - 'time', 'seconds', 'secs', 'minutes', 'mins' + - 'x', 'n' + - **date:** Is converted to a Date Object + - 'date', 'datetime', 'date_time' - **float:** Is converted to a Float wrapped in a Number Object - - 'float', 'decimal' + - 'float', 'decimal' - **file:** Is converted to a String Object if it is a valid path - - 'path', 'file', 'directory', 'dir' + - 'path', 'file', 'directory', 'dir' - **email:** Converted to a String Object if it is a valid email format - - 'email' + - 'email' - **url:** Converted to a String Object if it is a valid URL format - - 'url', 'uri', 'domain', 'host' - - **ip:** Converted to a String Object if it is a valid IP Address format - - 'ip' - - **true:** Converted to true if argument is present on command line - - 'bool', 'boolean', 'on' + - 'url', 'uri', 'domain', 'host' + - **ip:** Converted to a String Object if it is a valid IPv4 Address format + - 'ip' + - **true:** Converted to true if argument is present on command line + - 'bool', 'boolean', 'on' - **false:** Converted to false if argument is present on command line - - 'false', 'off', false, 0 + - 'false', 'off', false, 0 4. A default value for this option if one is not given on the command line ## Helper methods