Align documentation with current project name specification flag

When using the "--app" flag, the following warning is produced:

 [WARN] The 'app' argument should no longer be used; use 'project' instead.

 This change updates the documentation from suggesting "--app" to "--project"
This commit is contained in:
Erik Erikson
2016-05-03 10:31:00 -07:00
parent 9e63ac6d5b
commit ee77fccffd

View File

@@ -22,18 +22,18 @@ The latest CLI can be downloaded from bintray's
On *nix On *nix
``` ```
$ ./bin/dependency-check.sh -h $ ./bin/dependency-check.sh -h
$ ./bin/dependency-check.sh --app Testing --out . --scan [path to jar files to be scanned] $ ./bin/dependency-check.sh --project Testing --out . --scan [path to jar files to be scanned]
``` ```
On Windows On Windows
``` ```
> bin/dependency-check.bat -h > bin/dependency-check.bat -h
> bin/dependency-check.bat --app Testing --out . --scan [path to jar files to be scanned] > bin/dependency-check.bat --project Testing --out . --scan [path to jar files to be scanned]
``` ```
On Mac with [Homebrew](http://brew.sh) On Mac with [Homebrew](http://brew.sh)
``` ```
$ brew update && brew install dependency-check $ brew update && brew install dependency-check
$ dependency-check -h $ dependency-check -h
$ dependency-check --app Testing --out . --scan [path to jar files to be scanned] $ dependency-check --project Testing --out . --scan [path to jar files to be scanned]
``` ```
### Maven Plugin ### Maven Plugin
@@ -85,13 +85,13 @@ On *nix
``` ```
$ mvn install $ mvn install
$ ./dependency-check-cli/target/release/bin/dependency-check.sh -h $ ./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 $ ./dependency-check-cli/target/release/bin/dependency-check.sh --project Testing --out . --scan ./src/test/resources
``` ```
On Windows On Windows
``` ```
> mvn install > mvn install
> dependency-check-cli/target/release/bin/dependency-check.bat -h > 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 > dependency-check-cli/target/release/bin/dependency-check.bat --project Testing --out . --scan ./src/test/resources
``` ```
Then load the resulting 'DependencyCheck-Report.html' into your favorite browser. Then load the resulting 'DependencyCheck-Report.html' into your favorite browser.