Improve README documentation#12
Merged
Merged
Conversation
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
2 participants
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.
PR Description
Summary
This PR updates README.MD and docs/README.md to resolve Task 4 (Update README.md) of the repository's status tracking. The documentation was completely outdated compared to the options present in the CLI entry point (main.py).
Key Changes
⚠️ Formatting & Safety Callouts: Integrated GitHub-flavored markdown alert callouts ([!WARNING], [!CAUTION]) to cleanly warn auditors of Windows-specific dependencies and permissions, improving overall repository structure.
🗺️ Command Tree Calibration: Rewrote the "Arbre des commandes" structure to match the indexes and selection flows of main.py exactly.
➕ Documented Missing Submenus: Added documentation for the main menu options 5. [Automation] and 6. [Contributeur] which were completely omitted in the previous README.
📦 Documented All Unlisted CLI Tools: Added full breakdowns to the tools table mapping scripts, APIs/technologies, and functions for:
Lookup Menu: 13. [SSL / TLS], 14. [Roblox], 15. [AI], and 16. [Holehe].
Security Menu: 11. [Webcam] and 12. [Ip reput].
Discord Menu: 7. [rpc_conf], 8. [Token check], and 9. [Webhook sender].
🎨 Visual Updates: Cleaned up logo placement and added dynamic badges for Stars, Forks, Issues, OS verification, and Language status.