diff --git a/README.md b/README.md index 220dfe6..e178e1c 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,14 @@ The auditing focuses on the entire SDLC process, where it can reveal risks from [![GitHub Release][release-img]][release] [![Downloads][download]][release] -[![Build Status](https://github.com/aquasecurity/chain-bench/workflows/Build/badge.svg?branch=main)](https://github.com/aquasecurity/chain-bench/actions) -[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/aquasecurity/chain-bench/blob/main/LICENSE) +[![Build Status](https://github.com/aquasecurity/chain-bench/workflows/Build/badge.svg?branch=main&style=flat-square)](https://github.com/aquasecurity/chain-bench/actions) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square)](https://github.com/aquasecurity/chain-bench/blob/main/LICENSE) +[![go-report-card][go-report-card]](https://goreportcard.com/report/github.com/aquasecurity/chain-bench) -[download]: https://img.shields.io/github/downloads/aquasecurity/chain-bench/total?logo=github -[release-img]: https://img.shields.io/github/release/aquasecurity/chain-bench.svg?logo=github +[download]: https://img.shields.io/github/downloads/aquasecurity/chain-bench/total?logo=github&style=flat-square +[release-img]: https://img.shields.io/github/release/aquasecurity/chain-bench.svg?logo=github&style=flat-square [release]: https://github.com/aquasecurity/chain-bench/releases +[go-report-card]: https://goreportcard.com/badge/github.com/aquasecurity/chain-bench?style=flat-square
@@ -29,7 +31,7 @@ The auditing focuses on the entire SDLC process, where it can reveal risks from # Quick start There is a primarily way to run chain-bench as a stand alone cli, that requires the personal access token of your account and the repository url in order to access your SCM. -### For example +### For example ``` chain-bench scan --repository-url --access-token -o ``` @@ -45,46 +47,46 @@ chain-bench scan --repository-url --access-token -o @@ -101,7 +103,7 @@ You can find the current implemented checks under [AVD - Software Supply Chain C Please raise issues here if chain-bench is not correctly implementing the test as described in the Benchmark. To report issues in the Benchmark itself (for example, tests that you believe are inappropriate), please join the CIS community. ## Contributing -Kindly read [Contributing](CONTRIBUTING.md) before contributing. +Kindly read [Contributing](CONTRIBUTING.md) before contributing. We welcome PRs and issue reports. ## Roadmap