Skip to content

Commit 4b79e8f

Browse files
authored
docs: streamline (#379)
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
1 parent 4fba0c1 commit 4b79e8f

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ Please sign off your commits, to show that you agree to publish your changes und
1111
, and to indicate agreement with [Developer Certificate of Origin (DCO)](https://developercertificate.org/).
1212

1313
```shell
14-
git commit --signed-off ...
14+
git commit -s ...
1515
```

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ This is a so-called **meta-package**, it does not ship any own functionality, bu
1414
This package's dependencies are tools* with one purpose in common:
1515
generate _[CycloneDX][link_website]_ Software-Bill-of-Materials (SBOM) from _node_-based projects.
1616

17-
| ecosystem | actual tool |
17+
| Ecosystem | Actual Tool |
1818
|:---------:|:------------|
1919
| _npm_ | [@cyclonedx/cyclonedx-npm](https://www.npmjs.com/package/%40cyclonedx/cyclonedx-npm) |
20-
| _pnpm_ | To be announced, suggestions welcome. <br/> Candidate: [cyclonedx-node-pnpm](https://github.com/CycloneDX/cyclonedx-node-pnpm) |
20+
| _pnpm_ | To be announced, suggestions welcome.<br/> Candidate: [cyclonedx-node-pnpm](https://github.com/CycloneDX/cyclonedx-node-pnpm) |
2121
| _yarn_ | [@cyclonedx/yarn-plugin-cyclonedx](https://www.npmjs.com/package/%40cyclonedx/yarn-plugin-cyclonedx) |
2222

2323
*) You should not depend on this very meta-package, instead depend on the actual tool that fits your specific (eco)system.
@@ -27,19 +27,19 @@ generate _[CycloneDX][link_website]_ Software-Bill-of-Materials (SBOM) from _nod
2727
There are systems, that are not node-targeting, but use node as a runtime/compiler environment, or use node package registry as a distribution system.
2828
These systems are out of scope. Therefore, the following tools are not part of this very meta-package.
2929

30-
| system | actual tool(s) |
30+
| System | Actual Tool(s) |
3131
|:------:|:---------------|
3232
| _Angular_ | Utilize [@cyclonedx/cyclonedx-esbuild](https://www.npmjs.com/package/@cyclonedx/cyclonedx-esbuild?activeTab=readme#use-with-angular) or [@cyclonedx/webpack-plugin](https://www.npmjs.com/package/%40cyclonedx/webpack-plugin?activeTab=readme#use-with-angular) |
33-
| _Bun_ | Utilize [@cyclonedx/`cyclonedx-esbuild`](https://www.npmjs.com/package/@cyclonedx/cyclonedx-esbuild?activeTab=readme#plugin-example-esbuild) |
33+
| _Bun_ | Utilize [@cyclonedx/cyclonedx-esbuild](https://www.npmjs.com/package/@cyclonedx/cyclonedx-esbuild?activeTab=readme#plugin-example-esbuild) |
3434
| _Bower_ | None. (_Bower_ is [deprecated](https://bower.io/blog/2017/how-to-migrate-away-from-bower/)!) |
35-
| _esbuild_ | [@cyclonedx/cyclonedx-esbuild](https://www.npmjs.com/package/%40cyclonedx/cyclonedx-esbuild) |
35+
| _Esbuild_ | [@cyclonedx/cyclonedx-esbuild](https://www.npmjs.com/package/%40cyclonedx/cyclonedx-esbuild) |
3636
| _Parcel_ | To be announced, suggestions welcome |
3737
| _React_ | Utilize [@cyclonedx/webpack-plugin](https://www.npmjs.com/package/%40cyclonedx/webpack-plugin?activeTab=readme#use-with-react) |
3838
| _Rollup_ | [rollup-plugin-sbom](https://www.npmjs.com/package/rollup-plugin-sbom) |
3939
| _Rspack_/_Rsbuild_ | To be announced, suggestions welcome |
4040
| _Svelte_ | To be announced, suggestions welcome |
4141
| _Vite_ | Utilize [rollup-plugin-sbom](https://www.npmjs.com/package/rollup-plugin-sbom?activeTab=readme#usage-with-vite) |
42-
| _webpack_ | [@cyclonedx/webpack-plugin](https://www.npmjs.com/package/%40cyclonedx/webpack-plugin) |
42+
| _Webpack_ | [@cyclonedx/webpack-plugin](https://www.npmjs.com/package/%40cyclonedx/webpack-plugin) |
4343

4444
## Library
4545

0 commit comments

Comments
 (0)