Skip to content

Commit f0bd05d

Browse files
committed
docs: update intro and description
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent 7dcd166 commit f0bd05d

File tree

2 files changed

+13
-19
lines changed

2 files changed

+13
-19
lines changed

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,14 @@ that provides advanced supply chain capabilities for cyber risk reduction.
1919
This Python package provides data models, validators and more,
2020
to help you create/render/read CycloneDX documents.
2121

22-
**This package is not designed for standalone use. It is a library.**
22+
**This package is not designed for standalone use. It is a software library.**
2323

2424
As of version `3.0.0`, the internal data model was adjusted to allow CycloneDX VEX documents to be produced as per
25-
[official examples](https://cyclonedx.org/capabilities/bomlink/#linking-external-vex-to-bom-inventory) linking a VEX
26-
documents to a separate BOM document.
25+
[official examples](https://cyclonedx.org/capabilities/bomlink/#linking-external-vex-to-bom-inventory) linking VEX to a separate CycloneDX document.
2726

2827
If you're looking for a CycloneDX tool to run to generate (SBOM) software bill-of-materials documents, why not checkout
2928
[CycloneDX Python][cyclonedx-python] or [Jake][jake].
3029

31-
Alternatively, you can use this module yourself in your application to programmatically generate CycloneDX BOMs.
32-
3330
## Documentation
3431

3532
View the documentation [here](https://cyclonedx-python-library.readthedocs.io/).

docs/index.rst

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,26 @@
1515
CycloneDX’s Python Library documentation
1616
====================================================
1717

18-
CycloneDX is a lightweight BOM specification that is easily created, human-readable, and simple to parse.
18+
OWASP `CycloneDX`_ is a full-stack Bill of Materials (BOM) standard
19+
that provides advanced supply chain capabilities for cyber risk reduction.
1920

20-
This CycloneDX module for Python can generate valid CycloneDX bill-of-material document containing an aggregate of all
21-
project dependencies.
21+
This Python package provides data models, validators and more,
22+
to help you create/render/read CycloneDX documents.
2223

23-
As of version ``3.0.0``, the internal data model was adjusted to allow CycloneDX VEX documents to be produced as per
24-
`official examples`_ linking VEX to a separate BOM.
24+
**This package is not designed for standalone use. It is a software library.**
2525

26-
This module is not designed for standalone use (i.e. it is not executable on it’s own). If you’re looking for a
27-
CycloneDX tool to run to generate (SBOM) software bill-of-materials documents, why not checkout:
26+
As of version ``3.0.0`` of this library, the internal data model was adjusted to allow CycloneDX VEX documents to be produced as per
27+
`official examples`_ linking VEX to a separate CycloneDX document.
2828

29-
* `CycloneDX Python`_
30-
* `Jake`_
31-
* `CycloneDX Tool Center`_
32-
33-
This library was designed to be used by developers - you can use this module yourself in your application to
34-
programmatically generate SBOMs.
29+
If you're looking for a CycloneDX tool to run to generate (SBOM) software bill-of-materials documents, why not checkout
30+
`CycloneDX Python`_ or `Jake`_.
3531

3632

33+
.. _CycloneDX: https://cyclonedx.org/
34+
.. _official examples: https://cyclonedx.org/capabilities/bomlink/#linking-external-vex-to-bom-inventory
3735
.. _CycloneDX Python: https://pypi.org/project/cyclonedx-bom/
3836
.. _Jake: https://pypi.org/project/jake
3937
.. _CycloneDX Tool Center: https://cyclonedx.org/tool-center/
40-
.. _official examples: https://cyclonedx.org/capabilities/bomlink/#linking-external-vex-to-bom-inventory
4138

4239

4340
.. toctree::

0 commit comments

Comments
 (0)