diff --git a/README.md b/README.md index 655f48a..a3f9540 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,22 @@ *Go client library for [OWASP Dependency-Track](https://dependencytrack.org/)* +## Introduction + +*client-go* is a Go library to interact with Dependency-Track's REST API, making it easy to implement +custom automation around Dependency-Track. + +Example use-cases include: + +* Interacting with Dependency-Track in CI/CD pipelines + * e.g. to implement quality gates, or generate build reports +* Uploading BOMs of various origins + * e.g. from all containers running in a Kubernetes cluster, see [sbom-operator](https://github.com/ckotzbauer/sbom-operator) +* Reacting to Webhook notifications + * e.g. to automate analysis decisions on findings, see [dtapac](https://github.com/nscuro/dtapac) +* Reporting and tracking of portfolio metrics in specialized systems + * e.g. to expose metrics to time-series databases like Prometheus, see [dependency-track-exporter](https://github.com/jetstack/dependency-track-exporter) + ## Installation ```