fix typos in README.md #301
Merged
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
I found a few typos, these are minor suggestions to improve formatting and readability.
In the "Options" section, there's a small formatting issue with the last line of the usage text:
Original: "-i, --info Info displays basic info of the scanned site` </pre>"
Suggested Change: "-i, --info Info displays basic info of the scanned site</pre>"
In the "Installation" section, there's a minor grammatical issue in the sentence: "The script install.sh will first install the latest version of torbot found in pypi,". You can make it more grammatically correct like this:
Suggested Change: "The script install.sh will first install the latest version of torbot found on PyPI,"
In the "Using Docker" section, there's a missing word in this sentence: "Ensure than you have a tor container running on port 9050." It should be "Ensure that you have a tor container running on port 9050."
In the "Curated Features" section, there's a small formatting issue with the checklist:
Original: "- [x] Visualization Module Revamp"
Suggested Change: "- [x] Visualization Module Revamp"
In the "References" section, there are some minor formatting issues with the citation numbers. For consistency, you can format them like this:
Original: "1. M. Glassman and M. J. Kang, “Intelligence in the internet age..."
Suggested Change: "1. M. Glassman and M. J. Kang, “Intelligence in the Internet age..."
In the "Maintainers" section, you can remove the ellipsis (...) as it doesn't seem necessary in this context.
KingAkeem
reviewed
Oct 7, 2023
KingAkeem
requested changes
Oct 7, 2023
KingAkeem
approved these changes
Oct 7, 2023
Merged
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.
Issue #
Changes Proposed
I found a few typos, these are minor suggestions to improve formatting and readability.
Explanation of Changes
In the "Options" section, there's a small formatting issue with the last line of the usage text:
Original: "-i, --info Info displays basic info of the scanned site` "
Suggested Change: "-i, --info Info displays basic info of the scanned site"
In the "Installation" section, there's a minor grammatical issue in the sentence: "The script install.sh will first install the latest version of torbot found in pypi,". You can make it more grammatically correct like this:
Suggested Change: "The script install.sh will first install the latest version of torbot found on PyPI,"
In the "Using Docker" section, there's a missing word in this sentence: "Ensure than you have a tor container running on port 9050." It should be "Ensure that you have a tor container running on port 9050."
In the "References" section, there are some minor formatting issues with the citation numbers. For consistency, you can format them like this:
Original: "1. M. Glassman and M. J. Kang, “Intelligence in the internet age..."
Suggested Change: "1. M. Glassman and M. J. Kang, “Intelligence in the Internet age..."
Screenshots of new feature/change