Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: describe scope #342

Merged
merged 2 commits into from
Oct 21, 2022
Merged

docs: describe scope #342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0154b9f
docs: define scope
jkowalleck Oct 21, 2022
956ced8
docs: define scope
jkowalleck Oct 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion HISTORY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.

## unreleased

## 4.0.1 - 2022-10-21

* Docs:
* Describe the "Out of Scope" section (via [#342])
* Fixed some typos

[#342]: https://github.com/CycloneDX/cyclonedx-node-module/pull/342

## 4.0.0 - 2022-10-21

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

If you are looking for a JavaScript/TypeScript library for working with CycloneDX, its data models or serialization,
then you might want to try [@cyclonedx/cyclonedx-library](https://www.npmjs.com/package/%40cyclonedx/cyclonedx-library).
Expand Down
25 changes: 19 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,27 @@ generate _[CycloneDX][link_website]_ Software Bill-of-Materials (SBOM) from _nod

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

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

💡 If you are looking for a JavaScript/TypeScript library for working with CycloneDX, its data models or serialization,
## Out of Scope

There are ecosystems, that are not node-based, but use node as a runtime/compiler environment.
These ecosystems are out of scope. Therefore, the following packages are not part of this very meta-package.

| ecosystem | actual tool |
|:---------:|:------------|
| _webpack_ | [@cyclonedx/webpack-plugin](https://www.npmjs.com/package/%40cyclonedx/webpack-plugin) |
| _Angular_ | [@cyclonedx/webpack-plugin](https://www.npmjs.com/package/%40cyclonedx/webpack-plugin) |
| _React_ | [@cyclonedx/webpack-plugin](https://www.npmjs.com/package/%40cyclonedx/webpack-plugin) |
| _Parcel_ | to be announced |

## Library

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

## Contributing
Expand Down