Skip to content

Commit f3ad1ab

Browse files
committed
docs: responsibilities & capabilities
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent 0ef0f6f commit f3ad1ab

File tree

2 files changed

+28
-11
lines changed

2 files changed

+28
-11
lines changed

README.md

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

23-
**This package is not designed for standalone use. It is a software library.**
24-
25-
As of version `3.0.0`, the internal data model was adjusted to allow CycloneDX VEX documents to be produced as per
26-
[official examples](https://cyclonedx.org/capabilities/bomlink/#linking-external-vex-to-bom-inventory) linking VEX to a separate CycloneDX document.
27-
28-
If you're looking for a CycloneDX tool to run to generate (SBOM) software bill-of-materials documents, why not checkout
29-
[CycloneDX Python][cyclonedx-python] or [Jake][jake].
23+
> [!NOTE]
24+
> This package is a software library not intended for standalone use.
25+
> For generating Software Bill of Materials (SBOM), check out [CycloneDX Python][cyclonedx-python] or [Jake][jake].
3026
3127
## Documentation
3228

33-
View the responsibilities, capabilities, install instructions, documentation
34-
and more in our [online documentation](https://cyclonedx-python-library.readthedocs.io/).
29+
Complete documentation is available on [Read the Docs][link_rtfd]. This includes:
30+
- Responsibilities & Capabilities
31+
- Install Instructions
32+
- API Reference
33+
- Usage Examples
34+
- Integration Guides
35+
- Best Practices
3536

3637
## Python Support
3738

docs/responsibilities_capabilities.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,25 @@ Responsibilities
2929
Capabilities
3030
============
3131

32-
* Enums for the following use cases:
33-
* Data models for the following use cases:
32+
* Enums and Data models for the following use cases:
33+
* :mod:`Bom and Metadata <cyclonedx.model.bom>`
34+
* :mod:`BomRef <cyclonedx.model.bom_ref>`
35+
* :mod:`Component, Evidence, Patch, Pedigree, and more <cyclonedx.model.component>`
36+
* :mod:`Organizational Contact and Entity <cyclonedx.model.contact>`
37+
* :mod:`Cryptographic properties and more <cyclonedx.model.crypto>`
38+
* :mod:`Definition and Standard <cyclonedx.model.definition>`
39+
* :mod:`Dependency <cyclonedx.model.dependency>`
40+
* :mod:`Impact and related Analysis <cyclonedx.model.impact_analysis>`
41+
* :mod:`Issue <cyclonedx.model.issue>`
42+
* :mod:`License Named, SPDX, Expression, and more <cyclonedx.model.license>`
43+
* :mod:`Lifecycle <cyclonedx.model.lifecycle>`
44+
* :mod:`Release Notes <cyclonedx.model.release_note>`
45+
* :mod:`Service <cyclonedx.model.service>`
46+
* :mod:`Tool <cyclonedx.model.tool>`
47+
* :mod:`Vulnerability and related Analysis <cyclonedx.model.vulnerability>`
48+
* :mod:`Attachment Copyright, DataFlow, ExternalReference, Hash, Property, and more <cyclonedx.model>`
3449
* Factories for the following use cases:
50+
* Create data models from any license descriptor string
3551
* Builders for the following use cases:
3652
* Build a :class:`Component <cyclonedx.model.component.Component>` data model that represents this library
3753
* Build a :class:`Tool <cyclonedx.model.tool.Tool>` data model that represents this library

0 commit comments

Comments
 (0)