updated readme

Former-commit-id: 4cf254d41b78f8e9b232d6b40ab866fee05deac6
This commit is contained in:
Jeremy Long
2013-08-07 22:41:29 -04:00
parent ffb3243bb6
commit 96eee95596

View File

@@ -1,24 +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.
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].
Initial Usage
-
-------------
On *nix
```
$ mvn install
$ cd target
$ java -jar dependency-check-[version].jar -h
$ java -jar dependency-check-[version].jar -a Testing -out . -scan ./test-classes -scan ./lib
$ ./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]