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.

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 📝 #189

Merged
merged 3 commits into from
Aug 21, 2022
Merged

Update README.md 📝 #189

merged 3 commits into from
Aug 21, 2022

Conversation

tusharxoxoxo
Copy link
Contributor

Fixed few grammatical errors in the README.md file

@tusharxoxoxo tusharxoxoxo requested a review from a team as a code owner August 19, 2022 08:58
@tusharxoxoxo
Copy link
Contributor Author

anybody here??

@nscuro
Copy link
Member

nscuro commented Aug 20, 2022

Hi @tusharxoxoxo, thanks for those corrections!

We'll need you to sign the DCO before we can merge your commits though. When you click on the Details link of the DCO check, it'll show you what you need to do.

Also, some of the parts you changed in README.md are output of the CLI. Would you mind applying your changes to those texts as well? See here for example:

LongHelp: `cyclonedx-gomod creates CycloneDX Software Bill of Materials (SBOM) from Go modules.
Multiple subcommands are offered, each targeting different use cases:
- SBOMs generated with "app" include only those modules that the target application
actually depends on. Modules required by tests or packages that are not imported
by the application are not included. Build constraints are evaluated, which enables
a very detailed view of what's really compiled into an application's binary.
- SBOMs generated with "mod" include the aggregate of modules required by all
packages in the target module. This optionally includes modules required by
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.
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
artifacts that they actually use. For example, a Go module may include "server" and
"client" applications, of which only the "client" is distributed to users.
Additionally, modules included in "client" may differ, depending on which platform
it was compiled for.
Vendors or maintainers may choose to use "mod" for internal use, where it's too
cumbersome to deal with many SBOMs for the same product. Possible use cases are:
- Tracking of component inventory
- Tracking of third party component licenses
- Continuous monitoring for vulnerabilities
"mod" may also be used to generate SBOMs for libraries.`,

@tusharxoxoxo
Copy link
Contributor Author

is it correct ??

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>
@nscuro nscuro added the documentation Improvements or additions to documentation label Aug 21, 2022
@nscuro nscuro merged commit a045269 into CycloneDX:main Aug 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants