Skip to content

Commit

Permalink
docs: add introduction
Browse files Browse the repository at this point in the history
Signed-off-by: nscuro <[email protected]>
  • Loading branch information
nscuro committed Jul 2, 2023
1 parent 18b5021 commit a9bb240
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

```
Expand Down

0 comments on commit a9bb240

Please sign in to comment.