diff --git a/README.md b/README.md index 9e11831c..fee43b1e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ -![GuardDog Banner](docs/images/banner.png) +# GuardDog [![Test](https://github.com/DataDog/guarddog/actions/workflows/test.yml/badge.svg)](https://github.com/DataDog/guarddog/actions/workflows/test.yml) [![Static analysis](https://github.com/DataDog/guarddog/actions/workflows/semgrep.yml/badge.svg)](https://github.com/DataDog/guarddog/actions/workflows/semgrep.yml) +

+ GuardDog +

+ GuardDog is a CLI tool that allows to identify malicious PyPI packages. It runs a set of heuristics on the package source code (through Semgrep rules) and on the package metadata. GuardDog can be used to scan local or remote PyPI packages using any of the available [heuristics](#heuristics). diff --git a/docs/images/banner.png b/docs/images/banner.png index f5806215..961fcccd 100644 Binary files a/docs/images/banner.png and b/docs/images/banner.png differ diff --git a/docs/images/logo.png b/docs/images/logo.png new file mode 100644 index 00000000..74e4a815 Binary files /dev/null and b/docs/images/logo.png differ