Simplify README. Make User friendly and up-to-date #152
Conversation
Apply Sweep Rules to your PR?
|
|
|
Docker Hub already accepted my changes) 🤔😁 |
WalkthroughThe changes in the pull request involve significant modifications to the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (6)
README.md (6)
1-2: Improve clarity of the project status messageThe current message about needing volunteers feels abrupt without context. Consider providing more specific details about what kind of help is needed.
-*We need more volunteers to join. PRs welcome!* +*We welcome contributors! We especially need help with:* +* Python 3.10+ compatibility improvements +* Documentation updates +* Bug fixes and testing + +*PRs are welcome!*🧰 Tools
🪛 LanguageTool
[uncategorized] ~1-~1: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: Porting to Python3.10+ is painful and the progress is moving slowly. *We n...(COMMA_COMPOUND_SENTENCE_2)
48-52: Enhance CLI documentation structureWhile directing users to
--helpis good, providing common use-cases upfront would be more user-friendly.-Run `proxybroker --help` for more information on the options available. -Run `proxybroker <command> --help` for more information on a command. +## Available Commands + +- `find`: Find and filter proxies +- `grab`: Save proxies to a file +- `serve`: Run a local proxy server + +For detailed options: +- Run `proxybroker --help` for general options +- Run `proxybroker <command> --help` for command-specific options
Line range hint
85-245: Improve API documentation formattingThe API documentation section has formatting issues:
- "Dropworn" is misspelled (should be "Dropdown")
- Code blocks could benefit from syntax highlighting
-<details><summary>Expand Dropworn</summary> +<details><summary>Expand Dropdown</summary>Also, consider adding a table of contents at the start of the API section for better navigation.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~84-~84: Did you mean “request”? If following ‘per’, nouns are often singular.
Context: ...example.gif) ### Proxy information per requestsExpand Dropworn</summ...
(CONFUSION_OF_NNS_NN_UN)
🪛 Markdownlint (0.35.0)
84-84: Expected: setext; Actual: atx
Heading style(MD003, heading-style)
88-88: Expected: setext; Actual: atx
Heading style(MD003, heading-style)
90-90: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
250-257: Enhance TODO list structure and clarityThe TODO items could be better organized and more specific.
-TODO ---- +## Roadmap + +### Documentation +- [ ] Create docs website for new proxybroker + +### Features +- [ ] Performance Improvements + - [ ] Check ping and response time + - [ ] Measure data transfer speed + - [ ] Track proxy uptime +- [ ] Security & Validation + - [ ] Implement data checksum verification + - [ ] Support proxy authentication +- [ ] Enhanced Proxy Support + - [ ] Test site access (Google, Twitter, etc.) + - [ ] Support custom URL testing + - [ ] Find outgoing IP for cascading proxy + - [ ] Auto-detect default ports🧰 Tools
🪛 LanguageTool
[style] ~252-~252: In American English, abbreviations like “etc.” require a period.
Context: ...[ ] Check site access (Google, Twitter, etc) and even your own custom URL's - [ ] I...(ETC_PERIOD)
271-272: Fix OS naming conventionsThere are inconsistencies in OS naming.
-Supported Operating System: Windows, Linux, MacOS +Supported Operating Systems: Windows, Linux, macOS🧰 Tools
🪛 LanguageTool
[grammar] ~271-~271: The operating system from Apple is written “macOS”.
Context: ...orted Operating System: Windows, Linux, MacOS *On UNIX-like systems (Linux / macOSX ...(MAC_OS)
297-301: Enhance requirements section with version informationThe requirements section could be more helpful with version specifications.
-Python 3.8+ -[aiohttp](https://pypi.python.org/pypi/aiohttp) -[aiodns](https://pypi.python.org/pypi/aiodns) -[maxminddb](https://pypi.python.org/pypi/maxminddb) +### Core Requirements +- Python 3.8 or higher + +### Python Dependencies +- [aiohttp](https://pypi.python.org/pypi/aiohttp) - Latest stable version +- [aiodns](https://pypi.python.org/pypi/aiodns) - Latest stable version +- [maxminddb](https://pypi.python.org/pypi/maxminddb) - Latest stable version + +Note: Specific versions are managed through `poetry` for development
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
README.md(4 hunks)
🧰 Additional context used
🪛 Markdownlint (0.35.0)
README.md
41-41: Expected: setext; Actual: atx
Heading style
(MD003, heading-style)
44-44: null
Dollar signs used before commands without showing output
(MD014, commands-show-output)
45-45: null
Dollar signs used before commands without showing output
(MD014, commands-show-output)
39-39: null
Bare URL used
(MD034, no-bare-urls)
268-268: Expected: setext; Actual: atx
Heading style
(MD003, heading-style)
270-270: Expected: setext; Actual: atx
Heading style
(MD003, heading-style)
282-282: Expected: setext; Actual: atx
Heading style
(MD003, heading-style)
295-295: Expected: setext; Actual: atx
Heading style
(MD003, heading-style)
302-302: Expected: setext; Actual: atx
Heading style
(MD003, heading-style)
276-276: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
277-277: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
265-265: null
Dollar signs used before commands without showing output
(MD014, commands-show-output)
279-279: null
Dollar signs used before commands without showing output
(MD014, commands-show-output)
273-273: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
284-284: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🪛 LanguageTool
README.md
[style] ~252-~252: In American English, abbreviations like “etc.” require a period.
Context: ...[ ] Check site access (Google, Twitter, etc) and even your own custom URL's - [ ] I...
(ETC_PERIOD)
[grammar] ~271-~271: The operating system from Apple is written “macOS”.
Context: ...orted Operating System: Windows, Linux, MacOS *On UNIX-like systems (Linux / macOSX ...
(MAC_OS)
| > Pypi package in progress. We will upload the up-to-date package under new name (proxybroker2) when the support for 3.10 is ready. https://github.com/bluet/proxybroker2/issues/89 | ||
|
|
||
| ### Use pre-built Docker image | ||
|
|
||
| ``` {.sourceCode .bash} | ||
| $ docker pull bluet/proxybroker2 | ||
| $ echo 'alias proxybroker="docker run -p 8888:8888 -v --rm bluet/proxybroker2"' >> ~/.bashrc && . ~/.bashrc # create alias |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Docker installation instructions need improvement
The current Docker instructions have several issues:
- The alias command is complex and might not work on all shells
- The
-vflag is incomplete (no volume mapping) - Missing explanation of the port mapping
-$ echo 'alias proxybroker="docker run -p 8888:8888 -v --rm bluet/proxybroker2"' >> ~/.bashrc && . ~/.bashrc # create alias
+# Create an alias for easier usage (optional)
+# For bash users:
+$ echo 'alias proxybroker="docker run --rm -p 8888:8888 bluet/proxybroker2"' >> ~/.bashrc && source ~/.bashrc
+
+# For zsh users:
+$ echo 'alias proxybroker="docker run --rm -p 8888:8888 bluet/proxybroker2"' >> ~/.zshrc && source ~/.zshrc
+
+# Note: Port 8888 is used for the proxy server. You can change it if needed.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| > Pypi package in progress. We will upload the up-to-date package under new name (proxybroker2) when the support for 3.10 is ready. https://github.com/bluet/proxybroker2/issues/89 | |
| ### Use pre-built Docker image | |
| ``` {.sourceCode .bash} | |
| $ docker pull bluet/proxybroker2 | |
| $ echo 'alias proxybroker="docker run -p 8888:8888 -v --rm bluet/proxybroker2"' >> ~/.bashrc && . ~/.bashrc # create alias | |
| > Pypi package in progress. We will upload the up-to-date package under new name (proxybroker2) when the support for 3.10 is ready. https://github.com/bluet/proxybroker2/issues/89 | |
| ### Use pre-built Docker image | |
🧰 Tools
🪛 Markdownlint (0.35.0)
41-41: Expected: setext; Actual: atx
Heading style
(MD003, heading-style)
44-44: null
Dollar signs used before commands without showing output
(MD014, commands-show-output)
45-45: null
Dollar signs used before commands without showing output
(MD014, commands-show-output)
39-39: null
Bare URL used
(MD034, no-bare-urls)
Summary by CodeRabbit
proxybroker2package.--helpfor command details.