Suggestion: Enhancing README examples for student users #7377
itsdakshjain
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Hi ProjectDiscovery team!
I'm a student and I've been using Nuclei for my security research. I love the tool!
https://github.com/itsdakshjain
I noticed the "Examples" table in the README shows great use cases (like Log4Shell or SQLi), but it doesn't show the actual command-line syntax for them. For a student or a beginner, seeing the specific command right next to the use case would make the tool much more "plug-and-play."
The Proposal:
Modify the README Examples table to include a column for "Sample Command."
Example:
Instead of just listing "SQL Injection detection," we could show:
nuclei -target <url> -tags sqliI'm very interested in contributing to this project. Would the maintainers be open to a Pull Request where I add these CLI examples to the documentation?
Thanks for building such an awesome tool!
Beta Was this translation helpful? Give feedback.
All reactions