Skip to content

docs: add table of contents to README #4901

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
avasis-ai wants to merge 1 commit into
base: main
Choose a base branch
from
+27 −0
Open

docs: add table of contents to README #4901

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,33 @@ We take the revenue from the enterprise product to fund more awesome open source

</div>

# Table of Contents

- [What is TruffleHog](#what-is-trufflehog-)
- [Discovery](#discovery-)
- [Classification](#classification-)
- [Validation](#validation-)
- [Analysis](#analysis-)
- [Join Our Community](#loudspeaker-join-our-community)
- [Demo](#tv-demo)
- [Installation](#floppy_disk-installation)
- [Verifying the artifacts](#closed_lock_with_key-verifying-the-artifacts)
- [Quick Start](#rocket-quick-start)
- [FAQ](#question-faq)
- [What's new in v3?](#newspaper-whats-new-in-v3)
- [Usage](#memo-usage)
- [S3](#s3)
- [TruffleHog GitHub Action](#octocat-trufflehog-github-action)
- [TruffleHog GitLab CI](#trufflehog-gitlab-ci)
- [Pre-commit Hook](#pre-commit-hook)
- [Custom Regex Detector (alpha)](#custom-regex-detector-alpha)
- [Generic JWT Detection](#generic-jwt-detection)
- [Analyze](#mag-analyze)
- [Contributors](#heart-contributors)
- [Contributing](#computer-contributing)
- [Use as a library](#use-as-a-library)
- [License Change](#license-change)

# What is TruffleHog 🐽

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.
Expand Down
Loading