Skip to content

Commit 160644b

Browse files
authored
docs: add readme hint for PackageUrlFactory (#147)
* docs: add README hint for PackageUrlFactory * docs: fix a typo in HISTORY Signed-off-by: Jan Kowalleck <[email protected]>
1 parent e05f837 commit 160644b

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

HISTORY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ All notable changes to this project will be documented in this file.
1717
* Factory for `PackageURL` from `Models.Component` can handle additional data sources, now. (via [#146])
1818
* `Models.Component.hashes` map -> `PackageURL.qualifiers.checksum` list
1919
* `Models.Component.externalReferences[distribution].url` -> `PackageURL.qualifiers.download_url`
20-
* Method `Factories.PackageUrlFactory.makeFromComponent()` got a new optional param `sort`,
20+
* Method `Factories.PackageUrlFactory.makeFromComponent()` got a new optional parameter `sort`,
2121
to indicate whether to go the extra mile and bring hashes and qualifiers in alphabetical order.
2222
This feature switch is related to reproducible builds.
2323

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,10 @@ written in _TypeScript_ and compiled for the target.
5353
* `Tool`, `ToolRepository`
5454
* Factories for the following use cases:
5555
* Create data models from any license descriptor string
56+
* Create `PackageURL` from `Component` data models
5657
* Specific to _Node.js_: create data models from PackageJson-like data structures
5758
* Builders for the following use cases:
58-
* Specific to _Node.js_: create deep data models from PackageJson-like data structures
59+
* Specific to _Node.js_: create deep data models `Tool` or `Component` from PackageJson-like data structures
5960
* Implementation of the [_CycloneDX_ Specification][CycloneDX-spec] for the following versions:
6061
* `1.4`
6162
* `1.3`

0 commit comments

Comments
 (0)