README Total Detectors badge & small improvements (#584)

* Add Total Detectors badge to README

* A few README quality of life updates
This commit is contained in:
Max Thomson 2022-05-25 11:53:40 -07:00 committed by GitHub
parent 6fa2171a22
commit d98833b70b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -6,10 +6,14 @@
---
<center>
[![CI Status](https://github.com/trufflesecurity/trufflehog/actions/workflows/release.yml/badge.svg)](https://github.com/trufflesecurity/trufflehog/actions)
[![Go Report Card](https://goreportcard.com/badge/github.com/trufflesecurity/trufflehog/v3)](https://goreportcard.com/report/github.com/trufflesecurity/trufflehog/v3)
![License](https://img.shields.io/badge/license-AGPL--3.0-brightgreen)
[![License](https://img.shields.io/badge/license-AGPL--3.0-brightgreen)](/LICENSE)
[![Total Detectors](https://shields-staging.herokuapp.com/github/directory-file-count/trufflesecurity/truffleHog/pkg/detectors?label=Total%20Detectors&type=dir)](/pkg/detectors) <!-- Badge must be run from staging, see badges/shields#5967 -->
</center>
---
@ -155,7 +159,8 @@ docker run -it -v "$PWD:/pwd" trufflesecurity/trufflehog:latest github --org=tru
### TruffleHog OSS Github Action
```- name: TruffleHog OSS
```yaml
- name: TruffleHog OSS
uses: trufflesecurity/trufflehog@main
with:
# Repository path