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

Update README.md #116

Merged
merged 1 commit into from
Mar 22, 2023
+8 −2
Merged

Update README.md #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,22 @@ go install github.com/interlynk-io/sbomqs@latest
other installation [options](#installation).

# Usage
Quality score for a single sbom file
Creating Quality Score for a single sbom file
```sh
sbomqs score --filepath <sbom-file>
```

Sharable quality score
Creating a shareable link to the SBOM Quality Report at [sbombenchmark.dev](sbombenchmark.dev)
```sh
sbomqs share <sbom-file>
```

Example:
```
$sbomqs share cdxgen-9.5.1_alpine-latest.cdx.json
5.9 cdxgen-9.5.1_alpine-latest.cdx.json
ShareLink: https://sbombenchmark.dev/user/score?id=a97af1bf-4c9d-4a55-8524-3d4bcee0b9a4
```
# What is a high quality SBOM
A high quality SBOM should allow for managements of assets, license, vulnerabilities, Intellectual Property, configuration management and incident response.

Expand Down