Skip to content

Commit 8849709

Browse files
authored
docs: Recognized file patterns (#562)
mimic https://cyclonedx.org/specification/overview/ Signed-off-by: Jan Kowalleck <jan.kowalleck@owasp.org>
1 parent 0c9410a commit 8849709

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,18 @@ The following media types are officially registered with IANA:
5454

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

57+
58+
## Recognized file patterns
59+
60+
The following file names are conventionally used for storing CycloneDX BOM files:
61+
* `bom.json` for JSON encoded CycloneDX BOM files.
62+
* `bom.xml` for XML encoded CycloneDX BOM files.
63+
64+
Alternatively, files that match the glob pattern below are also recognized:
65+
* `*.cdx.json` for JSON encoded CycloneDX BOM files.
66+
* `*.cdx.xml` for XML encoded CycloneDX BOM files.
67+
68+
5769
## Release History
5870

5971
| Version | Release Date |

0 commit comments

Comments
 (0)