Skip to content

Commit d48411c

Browse files
committed
Update readme
Signed-off-by: Prabhu Subramanian <[email protected]>
1 parent e2394db commit d48411c

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ This tool creates a valid and compliant [CycloneDX][cyclonedx-homepage] Software
66

77
When used with plugins, cdxgen could generate an SBoM for Linux docker images and even VMs running Linux or Windows operating system.
88

9+
NOTE:
10+
11+
CycloneDX 1.5 specification is brand new and unsupported by many downstream tools. Use version 8.6.0 for 1.4 compatibility.
12+
913
## Supported languages and package format
1014

1115
| Language/Platform | Package format | Transitive dependencies |
@@ -73,12 +77,17 @@ For go, `go mod why` command is used to identify required packages. For php, com
7377

7478
```shell
7579
sudo npm install -g @cyclonedx/cdxgen
80+
81+
# For CycloneDX 1.4 compatibility use version 8.6.0
82+
sudo npm install -g @cyclonedx/[email protected]
7683
```
7784

7885
You can also use the cdxgen container image
7986

8087
```bash
8188
docker run --rm -v /tmp:/tmp -v $(pwd):/app:rw -t ghcr.io/cyclonedx/cdxgen -r /app -o /app/bom.json
89+
90+
docker run --rm -v /tmp:/tmp -v $(pwd):/app:rw -t ghcr.io/cyclonedx/cdxgen:v8.6.0 -r /app -o /app/bom.json
8291
```
8392

8493
## Getting Help

0 commit comments

Comments
 (0)