-
Notifications
You must be signed in to change notification settings - Fork 86
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update README to remove non-existent commands
Refresh the README to be more in-line with the commands that exist in the Makefile. Also, bring the casing of Claircore in-line with convention (Claircore == good in prose, claircore == good in code, ClairCore == bad). Signed-off-by: crozzy <[email protected]>
- Loading branch information
Showing
1 changed file
with
15 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,26 @@ | ||
![](https://github.com/quay/claircore/workflows/CI/badge.svg) | ||
# ClairCore | ||
# Claircore | ||
|
||
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. | ||
Claircore is designed to be embedded into a service wrapper. | ||
|
||
For a full overview see: [ClairCore Book](https://quay.github.io/claircore) | ||
For a full overview see: [Claircore Book](https://quay.github.io/claircore) | ||
|
||
# Local development and testing | ||
# Testing | ||
|
||
The following targets start and stop a local development environment | ||
``` | ||
make local-dev-up | ||
make local-dev-down | ||
``` | ||
|
||
If you modify libvuln or libindex code the following make targets will restart the services with your changes | ||
``` | ||
make libindexhttp-restart | ||
make libvulnhttp-restart | ||
The following make target runs unit tests which do not require a database or local development environment. | ||
```sh | ||
make unit | ||
# or make unit-v for verbose output | ||
``` | ||
|
||
With the local development environment up the following make target runs all tests including integration | ||
``` | ||
With the local development environment up the following make target runs all tests including integration. | ||
```sh | ||
make integration | ||
# or integration-v for verbose output | ||
``` | ||
|
||
The following make target runs unit tests which do not require a database or local development environment | ||
``` | ||
make unit | ||
With the local development environment up the following make target runs all tests including integration with full benchmark results. | ||
```sh | ||
make bench | ||
``` |