Support CycloneDX

README.md

@@ -6,14 +6,28 @@ A python script that translates machine-readable SBOMs into a format suitable fo
 This script merges SBOMs generated from Github's Dependabot tool
 and outputs it as a human readable excel file.
 
+Supported SBOM formats:
+- SPDX JSON v2.3
+- CycloneDX JSON v1.6
+
+This tool can also process SPDX SBOMs generated by VCPKG and combine them into a single SBOM with CPE entries. VCPKG is working on natively supporting security references in their SBOMs, but until then this tool can help fill the gap. See https://github.com/package-url/purl-spec/pull/562 and https://github.com/microsoft/vcpkg/discussions/36078
+
+
 # Usage
+If [uv](https://docs.astral.sh/uv/) is installed, you can run the tool without setting up an environment. Simply execute the script with the required arguments.
+
 
 ```
-usage: gen_sbom.py [-h] client_name input_directory output_file
+Usage: gen_sbom.py [OPTIONS] INPUT_DIRECTORY_PATH OUTPUT_FILE_PATH
 
-positional arguments:
-  input_directory  Github SBOM json files directory.
-  output_file      Output combined SBOM excel file path.
+  Generate a combined SBOM from multiple SPDX and CycloneDX SBOMs in the input
+  directory.
 
-optional arguments:
-  -h, --help       show this help message and exit
+Options:
+  --verbose                Enable verbose logging.
+  --author-name TEXT       Override the Author Name.
+  --vcpkg                  Combine VCPKG SBOMs.
+  --spdx-output-file FILE  Output combined SPDX SBOM file path (for VCPKG
+                           only).
+  --help                   Show this message and exit.
+```