Skip to content

Commit ef941cb

Browse files
authored
Merge pull request #11 from shiftleftcyber/feat/AddMoreInfoToREADME
chore: update README
2 parents dfd546e + d14e4ce commit ef941cb

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
[![Go Report Card](https://goreportcard.com/badge/github.com/shiftleftcyber/sbom-validator)](https://goreportcard.com/report/github.com/shiftleftcyber/sbom-validator)
66
![GitHub release (latest by date)](https://img.shields.io/github/v/release/shiftleftcyber/sbom-validator)
77

8-
98
## Overview
109

1110
**sbom-validator** is a Go library designed to validate
@@ -94,6 +93,19 @@ or you can use the included Makefile
9493
make test
9594
```
9695

96+
## Running the example
97+
98+
You can build an example app and pass in an SBOM
99+
100+
```sh
101+
make build
102+
103+
./bin/sbom-validator-example -file sample-sboms/sample-1.6.cdx.json
104+
CycloneDX SBOM type detected
105+
CycloneDX version is set to: 1.6
106+
SBOM is valid
107+
```
108+
97109
## License
98110

99111
This project is licensed under the MIT License.

0 commit comments

Comments
 (0)