docs: Announce and annotate the generator for BOM's SerialNumber (#282)

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

HISTORY.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 ## unreleased
 
+* Docs
+  * Announce and annotate the generator for BOM's SerialNumber ([#277] via [#282])
+  
+[#282]: https://github.com/CycloneDX/cyclonedx-php-library/pull/282
+
 ## 2.1.0 - 2023-03-24
 
 * Fixed
@@ -13,7 +18,8 @@ All notable changes to this project will be documented in this file.
   * `\CycloneDX\Core\Models\Bom::setSerialNumber()` no longer throws `\DomainException` when the value is of an unsupported format ([#277] via [#278])  
     This is considered a non-breaking behaviour change, because the corresponding normalizers assure valid data results.
 * Added
-  * Bom serialNumber generator: `\CycloneDX\Core\Utils\BomUtility::randomSerialNumber()` ([#277] via [#278])
+  * Published generator for BOM's SerialNumber: `\CycloneDX\Core\Utils\BomUtility::randomSerialNumber()` ([#277] via [#278])  
+    The code was donated from [cyclonedx-php-composer](https://github.com/CycloneDX/cyclonedx-php-composer).
 
 [#277]: https://github.com/CycloneDX/cyclonedx-php-library/issues/277
 [#278]: https://github.com/CycloneDX/cyclonedx-php-library/pull/278

README.md

@@ -48,6 +48,8 @@ Work with Bill of Materials (BOM) in [CycloneDX] format.
   * `Metadata`
   * `Property`, `PropertyRepository`
   * `Tool`, `ToolRepository`
+* Utilities for the following use cases:
+  * Generate valid random SerialNumbers for `Bom.serialNumber`
 * Factories for the following use cases:
   * Create data models from any license descriptor string
 * Implementation of the [_CycloneDX_ Specification][CycloneDX-spec] for the following versions:

src/Core/Utils/BomUtility.php

@@ -34,6 +34,10 @@
 abstract class BomUtility
 {
     /**
+     * Generate valid random SerialNumbers for {@see \CycloneDX\Core\Models\Bom::setSerialNumber()}.
+     *
+     * @since 2.1.0
+     *
      * @throws Exception if an appropriate source of randomness cannot be found
      */
     public static function randomSerialNumber(): string