diff --git a/README.md b/README.md index 5d46b655..cd4f8c96 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ Commands: ### generate ```bash -sage: opossum-file generate [OPTIONS] +Usage: opossum-file generate [OPTIONS] Generate an Opossum file from various other file formats. @@ -56,11 +56,19 @@ sage: opossum-file generate [OPTIONS] - Opossum Options: - --spdx PATH SPDX files used as input. - -o, --outfile TEXT The file path to write the generated opossum document - to. If appropriate, the extension ".opossum" will be - appended. [default: output.opossum] - --help Show this message and exit. + --spdx PATH Specify a path to a SPDX file that you would like to + include in the final output. Option can be repeated. + --opossum PATH Specify a path to a .opossum file that you would like + to include in the final output. Option can be + repeated. + --scan-code-json PATH Specify a path to a .json file generated by ScanCode + that you would like to include in the final output. + Option can be repeated. + -o, --outfile TEXT The file path to write the generated opossum document + to. If appropriate, the extension ".opossum" will be + appended. [default: output.opossum] + --help Show this message and exit. + ```