Skip to content

Commit f477bf0

Browse files
committed
doc: updated README to explain support for Vulnerability Disclosures
Signed-off-by: Paul Horton <[email protected]>
1 parent d496695 commit f477bf0

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,13 @@ parser = EnvironmentParser()
6565

6666
### Modelling
6767

68-
You can create a BOM Model from either an Parser instance or manually using the methods avaialbel directly on the `Bom` class.
68+
You can create a BOM Model from either a Parser instance or manually using the methods avaialbel directly on the `Bom` class.
69+
70+
The model also supports definition of vulnerabilities for output using the CycloneDX schema extension for
71+
[Vulnerability Disclosures](https://cyclonedx.org/use-cases/#vulnerability-disclosure) as of version 0.3.0.
72+
73+
**Note:** Known vulnerabilities associated with Components can be sourced from various data sources, but this library
74+
will not source them for you. Perhaps look at [Jake](https://github.com/sonatype-nexus-community/jake) if you're interested in this.
6975

7076
#### Example from a Parser
7177

0 commit comments

Comments
 (0)