Add README.md

This commit is contained in:
zacheryasc 2026-03-11 05:09:18 +00:00
parent e46e85a244
commit 7495295a95

9
README.md Normal file
View 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
```