From ec3138964d02a46771734eb50f791e17dfa4aa5a Mon Sep 17 00:00:00 2001
From: jake <jake.young.dev@gmail.com>
Date: Sat, 10 May 2025 14:42:12 -0400
Subject: [PATCH] README update

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index 7502ad5..fdc37c9 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,13 @@
 # npm-audit
 
+runs security checks for node projects
+
+## Steps
+### npm-audit
+```
+'npm audit' is run against the project files to scan for vulnerabilities in dependencies
+```
+
+## TODO
+- expand this repository to do more than dependency steps, as of now it doesn't make a ton of sense for this to be its own action/repo
+- add static code analysis step
\ No newline at end of file