From 7495295a95ceb6e01c6162e5458e2c82fe8f07d3 Mon Sep 17 00:00:00 2001
From: zacheryasc <zacheryasc@gmail.com>
Date: Wed, 11 Mar 2026 05:09:18 +0000
Subject: [PATCH] Add README.md

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 README.md

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 <any> -v # runs the command and gives an explanation of the metrics
+```
\ No newline at end of file