Skip to content

Commit eb908bd

Browse files
fixed minor grammatical and punctuation issues (#4369)
1 parent 1903b91 commit eb908bd

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ We take the revenue from the enterprise product to fund more awesome open source
3838

3939
# What is TruffleHog 🐽
4040

41-
TruffleHog is the most powerful secrets **Discovery, Classification, Validation,** and **Analysis** tool. In this context secret refers to a credential a machine uses to authenticate itself to another machine. This includes API keys, database passwords, private encryption keys, and more...
41+
TruffleHog is the most powerful secrets **Discovery, Classification, Validation,** and **Analysis** tool. In this context, secret refers to a credential a machine uses to authenticate itself to another machine. This includes API keys, database passwords, private encryption keys, and more...
4242

4343
## Discovery 🔍
4444

4545
TruffleHog can look for secrets in many places including Git, chats, wikis, logs, API testing platforms, object stores, filesystems and more
4646

4747
## Classification 📁
4848

49-
TruffleHog classifies over 800 secret types, mapping them back to the specific identity they belong to. Is it an AWS secret? Stripe secret? Cloudflare secret? Postgres password? SSL Private key? Sometimes its hard to tell looking at it, so TruffleHog classifies everything it finds.
49+
TruffleHog classifies over 800 secret types, mapping them back to the specific identity they belong to. Is it an AWS secret? Stripe secret? Cloudflare secret? Postgres password? SSL Private key? Sometimes it's hard to tell looking at it, so TruffleHog classifies everything it finds.
5050

5151
## Validation ✅
5252

@@ -58,7 +58,7 @@ For the 20 some of the most commonly leaked out credential types, instead of sen
5858

5959
# :loudspeaker: Join Our Community
6060

61-
Have questions? Feedback? Jump in slack or discord and hang out with us
61+
Have questions? Feedback? Jump into Slack or Discord and hang out with us.
6262

6363
Join our [Slack Community](https://join.slack.com/t/trufflehog-community/shared_invite/zt-pw2qbi43-Aa86hkiimstfdKH9UCpPzQ)
6464

@@ -74,7 +74,7 @@ docker run --rm -it -v "$PWD:/pwd" trufflesecurity/trufflehog:latest github --or
7474

7575
# :floppy_disk: Installation
7676

77-
Several options available for you:
77+
Several options are available for you:
7878

7979
### MacOS users
8080

@@ -149,7 +149,7 @@ You need the following tool to verify signature:
149149

150150
- [Cosign](https://docs.sigstore.dev/cosign/system_config/installation/)
151151

152-
Verification steps are as follow:
152+
Verification steps are as follows:
153153

154154
1. Download the artifact files you want, and the following files from the [releases](https://github.com/trufflesecurity/trufflehog/releases) page.
155155

@@ -175,8 +175,8 @@ Verification steps are as follow:
175175

176176
Replace `{version}` with the downloaded files version
177177

178-
Alternatively, if you are using installation script, pass `-v` option to perform signature verification.
179-
This required Cosign binary to be installed prior to running installation script.
178+
Alternatively, if you are using the installation script, pass `-v` option to perform signature verification.
179+
This requires Cosign binary to be installed prior to running the installation script.
180180

181181
# :rocket: Quick Start
182182

@@ -245,7 +245,7 @@ trufflehog s3 --bucket=<bucket name> --results=verified,unknown
245245
trufflehog s3 --role-arn=<iam role arn>
246246
```
247247

248-
## 7: Scan a Github Repo using SSH authentication in docker
248+
## 7: Scan a Github Repo using SSH authentication in Docker
249249

250250
```bash
251251
docker run --rm -v "$HOME/.ssh:/root/.ssh:ro" trufflesecurity/trufflehog:latest git ssh://github.com/trufflesecurity/test_keys
@@ -575,7 +575,7 @@ In the example config above, we're scanning for live secrets in all PRs and Push
575575
576576
### Shallow Cloning
577577
578-
If you're incorporating TruffleHog into a standalone workflow and aren't running any other CI/CD tooling alongside TruffleHog, then we recommend using [Shallow Cloning](https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---depthltdepthgt) to speed up your workflow. Here's an example for how to do it:
578+
If you're incorporating TruffleHog into a standalone workflow and aren't running any other CI/CD tooling alongside TruffleHog, then we recommend using [Shallow Cloning](https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---depthltdepthgt) to speed up your workflow. Here's an example of how to do it:
579579
580580
```
581581
...

0 commit comments

Comments
 (0)