Skip to content

Commit

Permalink
Added newline descriptions to comments option in API/CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
adamlui authored Apr 12, 2024
1 parent d80d204 commit 62ef0dc
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Boolean options:
-q, --quiet Suppress all logging except errors.
Parameter options:
--comment="comment" Prepend comment to minified code.
--comment="comment" Prepend comment to minified code. Separate by line using '\n'.
Info commands:
-h, --help Display help screen.
Expand Down Expand Up @@ -182,14 +182,14 @@ minifyJS.minify(input, { dotFiles: true });

Available parameters (and their default settings) are:

Name | Type | Desciption | Default value
-------------|---------|---------------------------------------------------------|---------------
`recursive` | Boolean | Recursively search for nested files if dir path passed. | `true`
`verbose` | Boolean | Show logging in console/terminal. | `true`
`dotFolders` | Boolean | Include dotfolders in file search. | `false`
`dotFiles` | Boolean | Include dotfiles in file search. | `false`
`mangle` | Boolean | Shorten variable names (typically to one character). | `true`
`comment` | String | Comment to prepend to minified code. | `''`
Name | Type | Desciption | Default value
-------------|---------|-------------------------------------------------------------------|---------------
`recursive` | Boolean | Recursively search for nested files if dir path passed. | `true`
`verbose` | Boolean | Show logging in console/terminal. | `true`
`dotFolders` | Boolean | Include dotfolders in file search. | `false`
`dotFiles` | Boolean | Include dotfiles in file search. | `false`
`mangle` | Boolean | Shorten variable names (typically to one character). | `true`
`comment` | String | Comment to prepend to minified code. Separate by line using '\n'. | `''`

#

Expand Down

0 comments on commit 62ef0dc

Please sign in to comment.