updates the README.md (Add 'Global Registration' and 'Specific Registration') #65
Conversation
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
AmirhosseinEnayati
changed the title
Updated README.md to enhance clarity and detail about the HttpClientToCurl library, including usage examples and installation instructions.
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.
This PR updates the README.md to provide a clearer, modern, and more complete documentation structure for the HttpClientToCurl library.
🔧 Changes Introduced
Added new Quick Usage section with:
Global Registration example using AddHttpClientToCurlInGeneralMode
Specific Registration example using AddHttpClientToCurl
Added a dedicated Manual Usage (⚙️) section for direct usage without registration.
Reorganized the Usage Example order (Quick first, Manual second) for better readability.
Cleaned up headings, icons, and code formatting to improve consistency and GitHub rendering.
Updated overall Markdown structure for better navigation and visual hierarchy.
📘 Motivation
The previous README included only a basic usage example.
These changes make the documentation more developer-friendly by:
Clearly separating automatic (DI-based) and manual usage.
Showing real integration patterns for ASP.NET Core and IHttpClientFactory.
Improving discoverability for contributors and new users.
✅ Outcome
Developers can now:
Quickly register HttpClientToCurl globally or per-client.
Understand configuration differences at a glance.
Copy/paste complete working code samples from the README without extra setup.