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.

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

feat(docs): Improve readme files for better clarity and usage examples #1100

Merged
merged 1 commit into from
Nov 20, 2024

Conversation

StepSisStuck
Copy link
Contributor

Related to #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.

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 changed the title Improve readme files for better clarity and usage examples feat(docs): Improve readme files for better clarity and usage examples Nov 5, 2024
@g0tmi1k g0tmi1k self-assigned this Nov 20, 2024
@g0tmi1k g0tmi1k added the enhancement Enhancement label Nov 20, 2024
@g0tmi1k g0tmi1k merged commit 5f50c63 into danielmiessler:master Nov 20, 2024
@g0tmi1k
Copy link
Collaborator

g0tmi1k commented Nov 20, 2024

YES @StepSisStuck !

Great stuff - really like this =)

@StepSisStuck StepSisStuck deleted the better-readmes branch November 20, 2024 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants