Add README.md
This commit is contained in:
parent
e46e85a244
commit
7495295a95
1 changed files with 9 additions and 0 deletions
9
README.md
Normal file
9
README.md
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
# cstat
|
||||
Terminal CLI tool to examine a codebase through a statistical lens
|
||||
|
||||
## helpful commands
|
||||
```bash
|
||||
cstat --help # cli options
|
||||
cstat -v # basic dashboard plus explanation
|
||||
cstat <any> -v # runs the command and gives an explanation of the metrics
|
||||
```
|
||||
Loading…
Reference in a new issue