diff --git a/README.md b/README.md
index 6239b19..1675148 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,13 @@
 # donotpassgo
-donotpassgo is a github/gitea action to run standard go checks in pipelines.
+donotpassgo is a github/gitea action to run unit tests and standards/security checks for Go applications
 
-## TODO
-explain inputs in readme
-test
-does file naming matter here if the project has install.sh or /src will we overwrite?
-review MR, im drunk-ish
-some jobs need env vars still lol
\ No newline at end of file
+## Inputs
+|Input|Required|Values|Default|Description|
+|-----|-----|-----|-----|-----|
+|test-library|false|standard,ginkgo,none|none|unit testing library to use, tests are skipped if set to 'none'|
+|test-version|false|any ginkgo version|latest|the version of the testing library to use (only ginkgo supported atm, value is ignored if using standard lib testing)|
+|test-fail|false|yes,no|yes|does the job fail if unit tests fail|
+|static|false|yes,no|yes|do static code checks run|
+|static-fail|false|yes,no|yes|does the job fail if static code checks fail|
+|vulnerability|false|yes,no|yes|do dependencies get scanned for vulnerabilities|
+|vulnerability-fail|false|yes,no|yes|does the job fail if vulnerabilities are found|
\ No newline at end of file