Skip to content

docs: update README #1548

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: update README #1548

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
375fa33
docs: update README
BradLugo May 24, 2025
a2f2b6b
fixup! docs: update README
BradLugo May 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 27 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,33 @@
![](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.
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)

# 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 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.

## Development

### Testing

The following make target runs unit tests which do not require a database or local development environment.
```sh
Expand All @@ -20,7 +41,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
```
Loading