From 375fa33f095a303c657048e60be11e8bd80218ce Mon Sep 17 00:00:00 2001 From: Brad Lugo Date: Fri, 23 May 2025 22:52:11 -0700 Subject: [PATCH 1/3] docs: update README Adds the GoDoc badge, the codecov badge, a quick start section, and more general info about the library. Signed-off-by: Brad Lugo --- README.md | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index db654f573..45d66ae57 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,32 @@ -![](https://github.com/quay/claircore/workflows/CI/badge.svg) # Claircore +[![Build Status](https://github.com/quay/claircore/actions/workflows/main.yml/badge.svg)](https://github.com/quay/claircore/actions/workflows/main.yml) +[![GoDoc](https://pkg.go.dev/badge/github.com/quay/claircore?status.svg)](https://pkg.go.dev/github.com/quay/claircore) +[![codecov](https://codecov.io/github/quay/claircore/coverage.svg?branch=main)](https://codecov.io/github/quay/claircore?branch=main) -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 For a full overview see: [Claircore Book](https://quay.github.io/claircore) -# Testing +Claircore is a library that provides scanning container layers for installed packages +and reporting any discovered vulnerabilities. + +## Quick start + +### Requirements + +There some things claircore needs: +- A datastore. Claircore contains a PostgreSQL implementation out of the box. +- Enough storage for the images you intend to scan. + +### Basic components + +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. + +## Development + +### Testing The following make target runs unit tests which do not require a database or local development environment. ```sh @@ -20,7 +40,8 @@ make integration # or integration-v for verbose output ``` -With the local development environment up the following make target runs all tests including integration with full benchmark results. +With the local development environment up the following make target runs all tests including integration with full +benchmark results. ```sh make bench ``` From a2f2b6b25f365f783b63d72afa10e316c6ca3b69 Mon Sep 17 00:00:00 2001 From: Brad Lugo Date: Thu, 29 May 2025 11:20:22 -0700 Subject: [PATCH 2/3] fixup! docs: update README --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 45d66ae57..07e9901ae 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ [![GoDoc](https://pkg.go.dev/badge/github.com/quay/claircore?status.svg)](https://pkg.go.dev/github.com/quay/claircore) [![codecov](https://codecov.io/github/quay/claircore/coverage.svg?branch=main)](https://codecov.io/github/quay/claircore?branch=main) -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. For a full overview see: [Claircore Book](https://quay.github.io/claircore) @@ -20,7 +21,7 @@ There some things claircore needs: ### Basic components -Claircore's main entire points are: +Claircore's main entry 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. From 7e1a8b9454829ed668b279a18af7fb58cb8b225b Mon Sep 17 00:00:00 2001 From: Brad Lugo Date: Fri, 30 May 2025 09:53:25 -0700 Subject: [PATCH 3/3] fixup! docs: update README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 07e9901ae..3cb4dc6ce 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ [![GoDoc](https://pkg.go.dev/badge/github.com/quay/claircore?status.svg)](https://pkg.go.dev/github.com/quay/claircore) [![codecov](https://codecov.io/github/quay/claircore/coverage.svg?branch=main)](https://codecov.io/github/quay/claircore?branch=main) -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. +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. For a full overview see: [Claircore Book](https://quay.github.io/claircore)