diff --git a/README.md b/README.md index 17f6fd1..a486174 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ # donotpassgo -action to run general go code scans, includes dependency scan with govulncheck and static code analysis from gosec \ No newline at end of file +do not pass Go runs all general checks for Golang applications, all steps must pass for workflow to pass. + +## Steps +### govulncheck +``` +govulncheck is install using 'go install' and is used to scan the application dependencies and standard library. +``` + +### gosec +``` +gosec is used for static code analysis. +``` \ No newline at end of file