diff --git a/README.md b/README.md index 5cd9d1c1..5180cd95 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ # toolkit [![e2e](https://github.com/fluxcd/toolkit/workflows/e2e/badge.svg)](https://github.com/fluxcd/toolkit/actions) +[![report](https://goreportcard.com/badge/github.com/fluxcd/toolkit)](https://goreportcard.com/report/github.com/fluxcd/toolkit) +[![license](https://img.shields.io/github/license/fluxcd/toolkit.svg)](https://github.com/fluxcd/toolkit/blob/master/LICENSE) +[![release](https://img.shields.io/github/release/fluxcd/toolkit/all.svg)](https://github.com/fluxcd/toolkit/releases) Experimental toolkit for assembling CD pipelines the GitOps way. +![overview](docs/diagrams/tk-overview.png) + Components: * [Toolkit CLI](docs/cmd/tk.md) * [Source Controller](https://github.com/fluxcd/source-controller) * [Kustomize Controller](https://github.com/fluxcd/kustomize-controller) -To install the toolkit CLI, see these [instructions](install/README.md). +To install the toolkit CLI, follow the [instructions](install/README.md). diff --git a/docs/diagrams/tk-overview.png b/docs/diagrams/tk-overview.png new file mode 100644 index 00000000..4cbdf66b Binary files /dev/null and b/docs/diagrams/tk-overview.png differ