Skip to content

Commit 54716d5

Browse files
author
Charlie Saunders
committed
Adds default date format information to the readme.
1 parent 22300ab commit 54716d5

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,9 @@ $ <path>/days_between 2018-01-01 --today # -51 when run on 2018-02-21
5757
## API
5858
* `./days_between [<start_date> or --today] [<end_date> OR --offset=integer] [options]`
5959

60-
Date format: `YYYYMMDD` or `YYYY-MM-DD`. The output format matches the start date format for offset calculations and can be overridden and customized using the format option.
60+
Date format: `YYYYMMDD` or `YYYY-MM-DD`.
61+
62+
The output format matches the start date format for offset calculations and can be overridden and customized using the format option. If the `today` option is used, the output default format is `YYYY-MM-DD`.
6163

6264
## Options
6365
* -h, --help Print help info

0 commit comments

Comments
 (0)