Skip to content

Commit 4fa36b7

Browse files
committed
[doc] Update doc accordingly to options changes
1 parent e5bbd53 commit 4fa36b7

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
JS cyclomatic complexity report generator.
44

5-
Command-line tool and module to generate a complexity report on file tree Javascript files. It is based on [escomplex](https://github.com/philbooth/escomplex/) module results. Report stands in a .html file containing graphical representation of file tree when used from command-line.
5+
Command-line tool and module that generates a report of Javascript files complexity. It is based on [escomplex](https://github.com/philbooth/escomplex/) module's results.
6+
7+
In 'html' mode, command-line tool will create an .html file report containing graphical representation of files complexity and lines of code count.
68

79
[![Build Status](https://travis-ci.org/slyg/jscomplexity.png?branch=master)](https://travis-ci.org/slyg/jscomplexity)
810

@@ -38,13 +40,12 @@ Usage: jscomplexity [options]
3840
-V, --version output the version number
3941
-p, --pattern <pattern> glob pattern - default is current directory
4042
-o, --output <filename> (optional) customize html report filename - default is 'jscomplexity-report.html'
41-
-r, --reporter <reporter> (optional) specify a reporter: 'terminal', 'html' or 'all' - default is 'all'
42-
-v, --verbose (optional) outputs analysisis logs
43+
-r, --reporter <reporter> (optional) specify a reporter: 'terminal', 'html' or 'all' - default is 'terminal'
4344
```
4445

4546
:warning: Linux/OSX compliant only (I haven't tested it on Windows).
4647

47-
Example : `jscomplexity -p '{./src/*.js,./src/**/*.js}'`
48+
CLI Example : `jscomplexity -p '{src/*.js,src/**/*.js,!src/config/**}'`
4849

4950
### Sample outputs (gremlins.js)
5051

0 commit comments

Comments
 (0)