From f65607287ada0d46243b8b0f2f7e62b4e5f7d0c3 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 8 Jan 2025 15:02:15 +0100 Subject: [PATCH] docs: Recognized file patterns Signed-off-by: Jan Kowalleck --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index b12c9a80..f8e7e400 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,16 @@ Specific versions of CycloneDX can be specified by using the version parameter. The officially supported media type for Protocol Buffer format is `application/x.vnd.cyclonedx+protobuf`. +## Recognized file patterns +The following file names are conventionally used for storing CycloneDX BOM files: +* `bom.json` for JSON encoded CycloneDX BOM files. +* `bom.xml` for XML encoded CycloneDX BOM files. + +Alternatively, files that match the glob pattern below are also recognized: +* `*.cdx.json` for JSON encoded CycloneDX BOM files. +* `*.cdx.xml` for XML encoded CycloneDX BOM files. + ## Release History | Version | Release Date |