Skip to content

Commit

Permalink
docs: update README.md (#189)
Browse files Browse the repository at this point in the history
* Update README.md

Signed-off-by: Tushar Dahiya <tusharxoxoxo@gmail.com>

* Signed-off-by: Tushar Dahiya <tusharxoxoxo@gmail.com>

 Changes to be committed:
	modified:   internal/cli/cli.go

Signed-off-by: Tushar Dahiya <tusharxoxoxo@gmail.com>

Signed-off-by: Tushar Dahiya <tusharxoxoxo@gmail.com>
Co-authored-by: Niklas <nscuro@protonmail.com>
  • Loading branch information
tusharxoxoxo and nscuro committed Aug 21, 2022
1 parent 730898b commit a045269
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Multiple subcommands are offered, each targeting different use cases:
tests and test packages. Build constraints are NOT evaluated, allowing for
a "whole picture" view on the target module's dependencies.
- "bin" offers support of generating rudimentary SBOMs from binaries built with Go modules.
- "bin" offers support for generating rudimentary SBOMs from binaries built with Go modules.
Distributors of applications will typically use "app" and provide the resulting SBOMs
alongside their application's binaries. This enables users to only consume SBOMs for
Expand Down Expand Up @@ -276,7 +276,7 @@ sboms:
```

GoReleaser will execute `cmd`s in its `dist` directory, which is a subdirectory of the project root.
Because `app` and `mod` both expect the module's root directory as argument, `../` must be provided.
Because `app` and `mod` both expect the module's root directory as an argument, `../` must be provided.

### Docker 🐳

Expand Down Expand Up @@ -315,7 +315,7 @@ Refer to the [documentation](https://pkg.go.dev/github.com/CycloneDX/cyclonedx-g
Modules that use [vendoring](https://golang.org/ref/mod#go-mod-vendor) are, although in a limited manner, supported.
Limitations are as follows:

* **No hashes.** Go doesn't copy all module files to `vendor`, only those that are required to build
* **No hashes.** Go doesn't copy all module files to the `vendor`, only those that are required to build
and test the main module. Because [module checksums](#hashes) consider almost all files in a module's directory though,
calculating accurate hashes from the `vendor` directory is not possible. As a consequence, SBOMs for modules that use
vendoring do not include component hashes.
Expand Down
2 changes: 1 addition & 1 deletion internal/cli/cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Multiple subcommands are offered, each targeting different use cases:
tests and test packages. Build constraints are NOT evaluated, allowing for
a "whole picture" view on the target module's dependencies.
- "bin" offers support of generating rudimentary SBOMs from binaries built with Go modules.
- "bin" offers support for generating rudimentary SBOMs from binaries built with Go modules.
Distributors of applications will typically use "app" and provide the resulting SBOMs
alongside their application's binaries. This enables users to only consume SBOMs for
Expand Down

0 comments on commit a045269

Please sign in to comment.