Skip to content
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

Jump to bottom

Better readmes #929

Open
molangning opened this issue Nov 24, 2023 · 6 comments
Open

Better readmes #929

molangning opened this issue Nov 24, 2023 · 6 comments
Labels
help wanted

Comments

@molangning
Copy link
Contributor

Some readme rewrite would help newbies to know how to use the wordlists

e.g: raft wordlists are for bruteforcing directories and files, use it like cmd
@g0tmi1k
Copy link
Collaborator

g0tmi1k commented Feb 13, 2024

I'm not sure exactly what your saying @molangning
Are you wanting to put tutorials on how to use them? I would say that could get risky.

@g0tmi1k g0tmi1k added the proposal Status: Proposal label Feb 13, 2024
@molangning
Copy link
Contributor Author

It's not exactly like tutorials, but more of an overview of what the wordlists are more suited for as the structure is a mess right now.

@molangning molangning mentioned this issue Feb 16, 2024
Merged
@molangning
Copy link
Contributor Author

#969 is what I hope the readmes look like

@g0tmi1k
Copy link
Collaborator

g0tmi1k commented Jun 11, 2024

in that case, I'm all for it :)

@ItsIgnacioPortal
Copy link
Contributor

Note that the CONTRIBUTING.md file already contains some guidelines for writing the README.md files.

@ItsIgnacioPortal ItsIgnacioPortal mentioned this issue Jul 16, 2024
Merged
@g0tmi1k g0tmi1k added help wanted and removed proposal Status: Proposal labels Aug 12, 2024
@ItsIgnacioPortal
Copy link
Contributor

This issue is currently being resolved on Seclists-Express: ItsIgnacioPortal#13

StepSisStuck added a commit to StepSisStuck/SecLists that referenced this issue Nov 5, 2024
@StepSisStuck
Improve readme files for better clarity and usage examples
6b931eb 
Related to danielmiessler#929

Update README.md files to provide better guidance on using wordlists.

* **Discovery/Web-Content/README.md**
  - Add sections "Overview," "Usage," "Source," and "References" for each wordlist.
  - Include examples and tutorials for using the wordlists.
  - Provide step-by-step instructions and command examples.

* **Discovery/DNS/README.md**
  - Add sections "Overview," "Usage," "Source," and "References" for each wordlist.
  - Include examples and tutorials for using the wordlists.
  - Provide step-by-step instructions and command examples.

* **Discovery/Web-Content/api/README.md**
  - Add sections "Overview," "Usage," "Source," and "References" for each wordlist.
  - Include examples and tutorials for using the wordlists.
  - Provide step-by-step instructions and command examples.

* **Discovery/Web-Content/URLs/README.md**
  - Add sections "Overview," "Usage," "Source," and "References" for each wordlist.
  - Include examples and tutorials for using the wordlists.
  - Provide step-by-step instructions and command examples.
@StepSisStuck StepSisStuck mentioned this issue Nov 5, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@g0tmi1k @ItsIgnacioPortal @molangning