doc: updated docs to reflect support for Dependency Graph

Signed-off-by: Paul Horton <[email protected]>
CycloneDX · Apr 12, 2022 · a680544 · a680544
1 parent 56f3d5d
commit a680544
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 7 deletions.
diff --git a/docs/modelling.rst b/docs/modelling.rst
@@ -23,11 +23,8 @@ Vulnerabilities are supported by the Model as of version 0.3.0.
     **Note:** Known vulnerabilities associated with Components can be sourced from various data sources, but this library
     will not source them for you. Perhaps look at `Jake`_ if you're interested in this.
 
-Examples
---------
-
-From a Parser
-~~~~~~~~~~~~~
+Example BOM using a Parser
+--------------------------
 
     **Note:** Concreate parser implementations were moved out of this library and into `CycloneDX Python`_ as of version
     ``1.0.0``.
@@ -40,6 +37,19 @@ From a Parser
     parser = EnvironmentParser()
     bom = Bom.from_parser(parser=parser)
 
+Example BOM created programmatically
+------------------------------------
+
+.. note::
+
+    It is recommended that you have a good understanding of the `CycloneDX Schema`_ before attempting to create a BOM
+    programmatically with this library.
+
+
+For the most up-to-date in-depth examples, look at our `Unit Tests`_.
+
 
 .. _CycloneDX Python: https://github.com/CycloneDX/cyclonedx-python
-.. _Jake: https://pypi.org/project/jake
+.. _Jake: https://pypi.org/project/jake
+.. _CycloneDX Schema: https://cyclonedx.org/docs/latest
+.. _Unit Tests: https://github.com/CycloneDX/cyclonedx-python-lib/tree/main/tests
diff --git a/docs/schema-support.rst b/docs/schema-support.rst
@@ -36,7 +36,7 @@ supported in prior versions of the CycloneDX schema.
 +----------------------------+---------------+---------------------------------------------------------------------------------------------------+
 | ``bom.externalReferences`` | Yes           |                                                                                                   |
 +----------------------------+---------------+---------------------------------------------------------------------------------------------------+
-| ``bom.dependencies``       | No            |                                                                                                   |
+| ``bom.dependencies``       | Yes           | Since ``2.3.0``                                                                                   |
 +----------------------------+---------------+---------------------------------------------------------------------------------------------------+
 | ``bom.compositions``       | No            |                                                                                                   |
 +----------------------------+---------------+---------------------------------------------------------------------------------------------------+