Added param usage to README#35
Merged
CarlosLannister merged 1 commit intojunquera:developfrom Jul 10, 2025
Merged
Conversation
Added param usage for better undestanding to the user
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the README by showing the corresponding function parameters for each detection pattern.
- Replaces generic bullets with explicit flag examples under Credentials & Identity
- Introduces Location & Organization and Analytics & Tracking sections with parameter usage
- Extends flag listings for Digital Assets, Social Networks, Cryptographic Hashes, Financial Information, Dark Web URLs, and Paste Sites
Comments suppressed due to low confidence (3)
README.md:54
- [nitpick] The flag
own_name=Truemay be confusing; consider renaming it topersonal_name=Trueto match the item description and improve clarity.
- **Personal names** (`own_name=True`)
README.md:112
- [nitpick] All paste-site entries share the same
paste=Trueflag, which could be ambiguous. Consider either using specific flags per domain or clarifying in the text thatpaste=Truecovers all listed paste services.
- **justpaste.it** links (`paste=True`)
README.md:49
- The original list (with
-- **Base64** encoded data, etc.) remains above these new entries, resulting in duplicate bullets. Please remove the old generic list items and keep only the new parameterized ones.
- **Base64** encoded data (`base64=True`)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added param usage for better undestanding to the user