diff --git a/README.md b/README.md new file mode 100644 index 0000000..a30029c --- /dev/null +++ b/README.md @@ -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 -v # runs the command and gives an explanation of the metrics +``` \ No newline at end of file