From 376bfb67996fcce65d7465a548252b6e4624f86a Mon Sep 17 00:00:00 2001 From: Jeremy Long Date: Mon, 2 Sep 2013 12:44:24 -0400 Subject: [PATCH] updated site information Former-commit-id: 9c60f1219a84ad5e58beb0f055a628e951c8d924 --- README.md | 35 +++++++++++++++++------------------ 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 2021cfcbd..f8e519e0e 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,29 @@ Dependency-Check -========= +================ Dependency-Check is a utility that attempts to detect publicly 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]. +Documentation and links to production binary releases can be found on the [github pages](http://jeremylong.github.io/DependencyCheck/). Additionally, more information about the architecture and ways to extend dependency-check can be found on the [wiki]. -Notice -- - -A very big release of new functionality and plugins will be made available during the BlackHat Arsenal on July 31st, 2013. If you are at BlackHat stop by and see the demos! - -Usage -- - -> $ mvn package - -> $ cd target - -> $ java -jar dependency-check-[version].jar -h - -> $ java -jar dependency-check-[version].jar -a Testing -out . -scan ./test-classes -scan ./lib +Initial Usage +------------- +On *nix +``` +$ mvn install +$ ./dependency-check-cli/target/release/bin/dependency-check.sh -h +$ ./dependency-check-cli/target/release/bin/dependency-check.sh --app Testing --out . --scan ./src/test/resources +``` +On Windows +``` +> mvn install +> dependency-check-cli/target/release/bin/dependency-check.bat -h +> dependency-check-cli/target/release/bin/dependency-check.bat --app Testing --out . --scan ./src/test/resources +``` Then load the resulting 'DependencyCheck-Report.html' into your favorite browser. Mailing List -- +------------ Subscribe: [dependency-check+subscribe@googlegroups.com] [subscribe]