cleanup/docs: update README, add usage section #64
Conversation
This file contains 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
kbdharun
force-pushed
the
master
branch
2 times, most recently
from
8d38313 to
e7bbb5e
Compare
Signed-off-by: K.B.Dharun Krishna <[email protected]>
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.
Changes
This Pull request adds a usage section for
sslstrip.pyand revamps the entire README section.Details
Thanks for maintaining this wonderful tool, I am a maintainer at the tldr-pages project where we concisely document console commands in the form of cheat sheets. Our coverage extends across all CLI tools and platforms.
We generally prefer linking to the official documentation source/VCS repository to guide our users for further information.
Recently, we received a Pull request to add a cheat sheet for your tool (tldr-pages/tldr#12681), where the contributor has added more information link, to Kali Linux's documentation of the tool at https://www.kali.org/tools/sslstrip/ (while it contains usage information, it lacks crucial information about running
sslstripas root user which is documented only here). So I plan on suggesting linking to the README of your repository.With this PR merged, users of the tool/exploring it can get to know about the usage by taking a quick glance of the README.