updated readme and help text

davglass · Mar 19, 2018 · 13c11ee · 13c11ee
1 parent ed4d3fc
commit 13c11ee
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,9 @@
 NPM License Checker
 ===================
 
+*As of v17.0.0 the `failOn` and `onlyAllow` arguments take semicolons as delimeters instead of commas. Some license names contain
+commas and it messed with the parsing*
+
 Ever needed to see all the license info for a module and its dependencies?
 
 It's this easy:
@@ -76,8 +79,8 @@ Options
 * `--exclude [list]` exclude modules which licenses are in the comma-separated list from the output
 * `--relativeLicensePath` output the location of the license files as relative paths
 * `--summary` output a summary of the license usage',
-* `--failOn [list]` fail (exit with code 1) on the first occurrence of the licenses of the comma-separated list
-* `--onlyAllow [list]` fail (exit with code 1) on the first occurrence of the licenses not in the comma-seperated list
+* `--failOn [list]` fail (exit with code 1) on the first occurrence of the licenses of the semicolon-separated list
+* `--onlyAllow [list]` fail (exit with code 1) on the first occurrence of the licenses not in the semicolon-seperated list
 
 Exclusions
 ----------

diff --git a/bin/license-checker b/bin/license-checker
@@ -34,8 +34,8 @@ if (args.help) {
         '   --exclude [list] exclude modules which licenses are in the comma-separated list from the output',
         '   --relativeLicensePath output the location of the license files as relative paths',
         '   --summary output a summary of the license usage',
-        '   --failOn [list] fail (exit with code 1) on the first occurrence of the licenses of the comma-separated list',
-        '   --onlyAllow [list] fail (exit with code 1) on the first occurrence of the licenses not in the comma-seperated list',
+        '   --failOn [list] fail (exit with code 1) on the first occurrence of the licenses of the semicolon-separated list',
+        '   --onlyAllow [list] fail (exit with code 1) on the first occurrence of the licenses not in the semicolon-seperated list',
         '',
         '   --version The current version',
         '   --help  The text you are reading right now :)',