Skip to content

Commit d68612e

Browse files
authored
docs: describe scope (#342)
* docs: define scope Signed-off-by: Jan Kowalleck <[email protected]>
1 parent c5179a0 commit d68612e

File tree

2 files changed

+27
-7
lines changed

2 files changed

+27
-7
lines changed

HISTORY.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
44

55
## unreleased
66

7+
## 4.0.1 - 2022-10-21
8+
9+
* Docs:
10+
* Describe the "Out of Scope" section (via [#342])
11+
* Fixed some typos
12+
13+
[#342]: https://github.com/CycloneDX/cyclonedx-node-module/pull/342
14+
715
## 4.0.0 - 2022-10-21
816

917
This became a so-called **meta-package**, it does not ship any own functionality, but it is a collection of dependencies. (via [#321])
@@ -14,7 +22,6 @@ generate _CycloneDX_ Software Bill-of-Materials (SBOM) from _node_-based project
1422
* for _npm_-based projects: [@cyclonedx/cyclonedx-npm](https://www.npmjs.com/package/%40cyclonedx/cyclonedx-npm)
1523
* for _yarn_-based projects: to be announced
1624
* for _pnpm_-based projects: to be announced
17-
* for _parcel_-based projects: to be announced
1825

1926
If you are looking for a JavaScript/TypeScript library for working with CycloneDX, its data models or serialization,
2027
then you might want to try [@cyclonedx/cyclonedx-library](https://www.npmjs.com/package/%40cyclonedx/cyclonedx-library).

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,27 @@ generate _[CycloneDX][link_website]_ Software Bill-of-Materials (SBOM) from _nod
1616

1717
| ecosystem | actual tool |
1818
|:---------:|:------------|
19-
| _npm_ | [@cyclonedx/cyclonedx-npm](https://www.npmjs.com/package/%40cyclonedx/cyclonedx-npm) |
20-
| _yarn_ | to be announced <!-- maybe https://github.com/CycloneDX/cyclonedx-node-yarn --> |
21-
| _pnpm_ | to be announced <!-- maybe https://github.com/CycloneDX/cyclonedx-node-pnpm --> |
22-
| _parcel_ | to be announced |
19+
| _npm_ | [@cyclonedx/cyclonedx-npm](https://www.npmjs.com/package/%40cyclonedx/cyclonedx-npm) |
20+
| _yarn_ | to be announced <!-- maybe https://github.com/CycloneDX/cyclonedx-node-yarn --> |
21+
| _pnpm_ | to be announced <!-- maybe https://github.com/CycloneDX/cyclonedx-node-pnpm --> |
2322

24-
💡 You should not depend on this very package, but the actual tool that suites your specific ecosystem.
23+
You should not depend on this very meta-package, but the actual tool that suites your specific ecosystem.
2524

26-
💡 If you are looking for a JavaScript/TypeScript library for working with CycloneDX, its data models or serialization,
25+
## Out of Scope
26+
27+
There are ecosystems, that are not node-based, but use node as a runtime/compiler environment.
28+
These ecosystems are out of scope. Therefore, the following packages are not part of this very meta-package.
29+
30+
| ecosystem | actual tool |
31+
|:---------:|:------------|
32+
| _webpack_ | [@cyclonedx/webpack-plugin](https://www.npmjs.com/package/%40cyclonedx/webpack-plugin) |
33+
| _Angular_ | [@cyclonedx/webpack-plugin](https://www.npmjs.com/package/%40cyclonedx/webpack-plugin) |
34+
| _React_ | [@cyclonedx/webpack-plugin](https://www.npmjs.com/package/%40cyclonedx/webpack-plugin) |
35+
| _Parcel_ | to be announced |
36+
37+
## Library
38+
39+
If you are looking for a JavaScript/TypeScript library for working with CycloneDX, its data models or serialization,
2740
then you might want to try [@cyclonedx/cyclonedx-library](https://www.npmjs.com/package/%40cyclonedx/cyclonedx-library).
2841

2942
## Contributing

0 commit comments

Comments
 (0)