Revise README for clarity and additional details - #8
Merged
Conversation
Updated README to clarify functionality and usage.
Contributor
Author
|
@copilot review the README and make sure all features and include and documented. |
Contributor
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README to better reflect the tool's dual nature as both a CLI and MCP server, while simplifying the documentation. The key changes include:
- Updated title and description to emphasize both CLI and MCP server functionality
- Enhanced introduction with comparison to
jqand security features - Removed the "Prompt" section containing suggested agent instructions
- Simplified the MCP server description
* Initial plan * Document all features in README with detailed instructions Co-authored-by: alexec <1142830+alexec@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
Author
|
@copilot open a new pull request to apply changes based on the comments in this thread |
Contributor
Contributor
* Initial plan * Fix MPC typo to MCP on line 3 Co-authored-by: alexec <1142830+alexec@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
* Initial plan * Fix typo: change MPC to MCP on line 3 Co-authored-by: alexec <1142830+alexec@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: alexec <1142830+alexec@users.noreply.github.com> Co-authored-by: Alex Collins <alexec@users.noreply.github.com>
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
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.
Updated README to clarify functionality and usage.