Need for detailed documentation

[vm-mscs-mmxxiv]

Description

TruffleHog documentation especially around usage is required. For example it took me quite a long time to find how to ignore a line. Use trufflehog:ignore trailing comment on the line. For CLI flags it is not always clear what this flag suppose to do.

Preferred Solution

• Create a branch for documentation
• Ask for proof reading
• Examples for flags, like before after could give a hint

[everdone-app]

Hey there! We're from Everdone, the AI platform that helps developers skip the tedious parts of documentation.

We saw you were looking for help with documentation, and we thought a real-world example might be useful. As a gesture of support, we ran 20 of your files through Everdone to generate clear, structured documentation.

You can check out the time-saving results right here: https://app.everdone.ai/services/codedoc/documentation/3e828da0-93d8-487c-a18d-adf5d856d42f/trufflehog/main/main.go

Let us know your initial impressions! If you're interested in keeping your entire codebase documented effortlessly, you can try Everdone for free.