Skip to content

Commit 3f84b44

Browse files
committed
docs
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent 393f92f commit 3f84b44

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@
1313

1414
----
1515

16-
This Python package can render and read valid [CycloneDX][link_website] documents.
17-
OWASP CycloneDX is a full-stack Bill of Materials (BOM) standard
16+
OWASP [CycloneDX][link_website] is a full-stack Bill of Materials (BOM) standard
1817
that provides advanced supply chain capabilities for cyber risk reduction.
1918

20-
**This module is not designed for standalone use.**
19+
This Python package provides data models, validators and more,
20+
to help you create/render/read CycloneDX documents.
21+
22+
**This package is not designed for standalone use. It is a library.**
2123

2224
As of version `3.0.0`, the internal data model was adjusted to allow CycloneDX VEX documents to be produced as per
2325
[official examples](https://cyclonedx.org/capabilities/bomlink/#linking-external-vex-to-bom-inventory) linking a VEX
@@ -28,6 +30,8 @@ If you're looking for a CycloneDX tool to run to generate (SBOM) software bill-o
2830

2931
Alternatively, you can use this module yourself in your application to programmatically generate CycloneDX BOMs.
3032

33+
## Documentation
34+
3135
View the documentation [here](https://cyclonedx-python-library.readthedocs.io/).
3236

3337
## Python Support

0 commit comments

Comments
 (0)