docs: add comprehensive README with installation and usage guide#3
Merged
Conversation
Add complete documentation including: - Feature overview - cargo install from git instructions - CLI usage examples with JSON output - MCP server usage - Rust library examples with Tool builder - Python bindings examples - Response fields reference table - Error handling documentation - Configuration options (timeouts, binary detection, HTML conversion)
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What
Add complete README documentation for the webfetch project.
Why
The existing README was minimal (2 lines). Users need comprehensive documentation to understand how to install and use the tool.
How
Created detailed README covering:
cargo install --git(recommended) and from sourceRisk
Checklist