Skip to content

Commit 26a3ede

Browse files
committed
Update README.md
1 parent d16a3a1 commit 26a3ede

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,18 @@
33

44
Command-line tool to generate a complexity report on file tree Javascript files. It is based on [complexityReport.js](https://github.com/philbooth/complexityReport.js) module results. Report stands in a .html file containing graphical representation of file tree.
55

6-
NB : /!\ Linux/OS compliant only for now.
6+
NB: /!\ Linux/OS compliant only for now.
77

88

99
###Installation
1010

11-
1211
<code>npm install -g jscomplexity</code>
1312

1413

1514
###Usage
1615

16+
<code> $ jscr &lt;directory containing JS&gt; [optional : &lt;generated report directory, defaults current&gt;] </code>
1717

18-
<code> $ jscr <directory containing JS> [optional : <generated report directory, defaults current>] </code>
18+
e.g.:
19+
<code>$ jscr .</code>
20+
will generate report in current directory, using it as root for file tree walk-through.

0 commit comments

Comments
 (0)