Skip to content

Commit 1182759

Browse files
Add what's new and contributing sections to readme (#122)
* Add what's new and contributing sections to readme * readme update
1 parent a1dfcde commit 1182759

File tree

3 files changed

+18
-5
lines changed

3 files changed

+18
-5
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ Please create an issue to collect feedback prior to feature additions. If possib
44

55
When showing intereste, in a bug, enhancement, PR, or issue, please use the thumbs up/thumbs down emoji on the original message rather than adding comments expressing the same.
66

7-
Contributors need to sign our CLA before we are able to accept contributions:
7+
Contributors need to [sign our CLA](https://cla-assistant.io/trufflesecurity/trufflehog) before we are able to accept contributions.

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,19 @@ https://join.slack.com/t/trufflehog-community/shared_invite/zt-pw2qbi43-Aa86hkii
2222

2323
## Demo
2424

25-
![Stargazers over time](https://storage.googleapis.com/truffle-demos/non-interactive.svg)
25+
![GitHub scanning demo](https://storage.googleapis.com/truffle-demos/non-interactive.svg)
26+
27+
28+
# What's new in v3?
29+
30+
TruffleHog v3 is a complete rewrite in Go with many new powerful features.
31+
32+
- We've **added over 600 credential detectors that support active verification against their respective APIs**.
33+
- We've also added native **support for scanning GitHub, GitLab, filesystems, and S3**.
34+
35+
36+
## What is credential verification?
37+
For every potential credential that is detected, we've painstakingly implemented programatic verification against the API that we think it belongs to. Verification eliminates false positives. For example, the [AWS credential detector](pkg/detectors/aws/aws.go) performs a `GetCallerIdentity` API call against the AWS API to verify if an AWS credential is active.
2638

2739
## Installation
2840

@@ -119,9 +131,11 @@ This project exists thanks to all the people who contribute. [[Contribute](CONTR
119131
</a>
120132

121133

122-
## Stargazers over time
134+
## Contributing
135+
136+
Contributions are very welcome! Please see our [contribution guidelines first](CONTRIBUTING.md).
123137

124-
[![Stargazers over time](https://starchart.cc/trufflesecurity/trufflehog.svg#cache-bust)](https://starchart.cc/trufflesecurity/trufflehog)
138+
We no longer accept contributions to TruffleHog v2, but that code is available in the `v2` branch.
125139

126140
## License Change
127141

pkg/detectors/detectors.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import (
1111
"github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb"
1212
"github.com/trufflesecurity/trufflehog/v3/pkg/pb/source_metadatapb"
1313
"github.com/trufflesecurity/trufflehog/v3/pkg/pb/sourcespb"
14-
1514
"github.com/trufflesecurity/trufflehog/v3/pkg/sources"
1615
)
1716

0 commit comments

Comments
 (0)