arno/clair
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update heading in the README

Browse Source 
I was trying to audit some images I use locally at the command line.
I missed the relevant instructions until the third time I read the
README. Hopefully this new heading and text make it easier to catch
the reader's eye.

For more on README readability, please see
https://www.youtube.com/watch?v=sQP_hUNCrcE.
This commit is contained in:
Kevin Burke 2017-04-03 16:23:00 -07:00
parent 59ee75c502
commit b398a221a4
No known key found for this signature in database
GPG Key ID: 24B0EF06511BA263
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -27,12 +27,12 @@ Thus, the project was named `Clair` after the French term which translates to *c
## Common Use Cases ## Common Use Cases
### Manual Auditing ### Audit a single Docker image locally
You're building an application and want to depend on a third-party container image that you found by searching the internet. You're building an application and want to depend on a third-party container image that you found by searching the internet.
To make sure that you do not knowingly introduce a new vulnerability into your production service, you decide to scan the container for vulnerabilities. To make sure that you do not knowingly introduce a new vulnerability into your production service, you decide to scan the container for vulnerabilities.
You `docker pull` the container to your development machine and start an instance of Clair. Run `docker pull` to put the image on your development machine and then start an instance of Clair.
Once it finishes updating, you use the [local image analysis tool] to analyze the container. Once it finishes updating, use the [local image analysis tool] to analyze the container.
You realize this container is vulnerable to many critical CVEs, so you decide to use another one. You realize this container is vulnerable to many critical CVEs, so you decide to use another one.
[local image analysis tool]: https://github.com/coreos/clair/tree/master/contrib/analyze-local-images [local image analysis tool]: https://github.com/coreos/clair/tree/master/contrib/analyze-local-images
@ -198,4 +198,3 @@ To expose the new behavior, unqualified imports to the package must be added in
- [Projects integrating with Clair](https://github.com/coreos/clair/blob/master/Documentation/integrations.md) - [Projects integrating with Clair](https://github.com/coreos/clair/blob/master/Documentation/integrations.md)
- [Production users](https://github.com/coreos/clair/blob/master/Documentation/production-users.md) - [Production users](https://github.com/coreos/clair/blob/master/Documentation/production-users.md)