Improve README.md documentation with comprehensive guide and examples

[Copilot]

This PR significantly enhances the README.md documentation to provide a comprehensive guide for users of the waitfor-http library.

Key Improvements

Fixed Issues

• Corrected typo: Fixed "locahost" to "localhost" in the Quick Start example

Enhanced Documentation Structure

• Added project badges: Build status, Go Report Card, and codecov for better project visibility
• Expanded overview: Clear explanation of the library's purpose and integration with the waitfor framework
• Added installation instructions: Simple go get command for easy setup

Comprehensive Usage Examples

• Basic HTTP testing: Simple single endpoint testing
• Multiple endpoints: Testing several services simultaneously
• Advanced configuration: Examples with timeouts, custom retry attempts, and intervals

Technical Documentation

• API Reference: Documentation of the main http.Use() function and supported URL schemes
• Status Code Handling: Clear explanation of which HTTP status codes (2xx, 3xx) are considered successful vs failures (4xx, 5xx)
• Error Handling: Examples and explanation of different error types (network errors, HTTP errors, invalid URLs)

Project Information

• Integration guidance: Links to the main waitfor framework documentation
• Contributing guidelines: Encouragement for community contributions
• License information: Reference to Apache License 2.0

The improved documentation provides users with everything they need to understand, install, and effectively use the library, while maintaining the existing code functionality unchanged.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.