diff --git a/README.md b/README.md new file mode 100644 index 000000000..525148ff5 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +DependencyCheck +========= + +DependencyCheck is a utility that attempts to detect publically disclosed vulnerabilities contained within project dependencies. It does this by determining if there is a Common Platform Enumeration (CPE) identifier for a given dependency. If found, it will generate a report linking to the associated CVE entries. + +More information can be found on the [wiki]. + +Usage +- + +> $ mvn package +> $ cd target +> $ java -jar dependency-check-0.2.6.0.jar -h +> $ java -jar dependency-check-0.2.6.0.jar -a Testing -out . -scan ./test-classes -scan ./lib + +Then load the resulting 'DependencyCheck-Report.html' into your favorite browser. + +Mailing List +- + +Subscribe: [dependency-check+subscribe@googlegroups.com] [subscribe] +Post: [dependency-check@googlegroups.com] [post] + +License +- + +[GPLv3] + +Copyright (c) 2012-2013 Jeremy Long. All Rights Reserved. + + [wiki]: https://github.com/jeremylong/DependencyCheck/wiki + [subscribe]: mailto:dependency-check+subscribe@googlegroups.com + [post]: mailto:dependency-check@googlegroups.com + [GPLv3]: https://github.com/jeremylong/DependencyCheck/blob/master/LICENSE.txt \ No newline at end of file