docs: update README #1548
docs: update README #1548
Conversation
Adds the GoDoc badge, the codecov badge, a quick start section, and more general info about the library. Signed-off-by: Brad Lugo <[email protected]>
README.md
Outdated
|
|
||
| Claircore provides a set of go modules which handle scanning container layers for installed packages and reporting any discovered vulnerabilities. | ||
| Claircore is designed to be embedded into a service wrapper. | ||
| A container security library from Red Hat's Clair and Advanced Cluster Security teams.q |
There was a problem hiding this comment.
I'd say this doesn't need to be said, it doesn't mean anything unless you work at Red Hat.
There was a problem hiding this comment.
Agree, I don't think this change adds anything.
There was a problem hiding this comment.
What about something like:
| A container security library from Red Hat's Clair and Advanced Cluster Security teams.q | |
| Claircore provides a set of go modules which handle scanning container layers for installed packages and reporting any | |
| discovered vulnerabilities. The engine behind Clair and Advanced Cluster Security. |
I'd like to get across that this is The shared Red Hat library for container scanning.
There was a problem hiding this comment.
I guess I don't really know the intention behind adding the line, I could see that stackrox/ACS scanner readme mentioning that it uses claircore.
README.md
Outdated
|
|
||
| Claircore provides a set of go modules which handle scanning container layers for installed packages and reporting any discovered vulnerabilities. | ||
| Claircore is designed to be embedded into a service wrapper. | ||
| A container security library from Red Hat's Clair and Advanced Cluster Security teams.q |
There was a problem hiding this comment.
Agree, I don't think this change adds anything.
README.md
Outdated
| Claircore's main entire points are: | ||
| - `libindex`: The module that indexes packages and reports all packages for each layer. | ||
| - `libvuln`: The module that matches vulnerabilities using an index report. |
There was a problem hiding this comment.
I started writing out examples and usages for these, but decided to submit a full example: #1549
Description
Updates the README:
You can view the GitHub rendered view here: https://github.com/BradLugo/claircore/blob/blugo/update-readme/README.md