Skip to content

Commit

Permalink
docs: Recognized file patterns (#562)
Browse files Browse the repository at this point in the history
mimic https://cyclonedx.org/specification/overview/

Signed-off-by: Jan Kowalleck <jan.kowalleck@owasp.org>
  • Loading branch information
jkowalleck authored Jan 8, 2025
1 parent 0c9410a commit 8849709
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,18 @@ The following media types are officially registered with IANA:

Specific versions of CycloneDX can be specified by using the version parameter. For example: `application/vnd.cyclonedx+xml; version=1.6`.


## 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 |
Expand Down

0 comments on commit 8849709

Please sign in to comment.