Improve README.md documentation with comprehensive examples and better structure

[Copilot]

This PR significantly improves the README.md documentation to make it more helpful and comprehensive for users.

Changes Made

Fixes

• Fixed typo: Corrected "locahost" to "localhost" in the Quick start example
• Fixed installation URL: Updated the install script URL from go-waitfor/waitfor to go-waitfor/cli repository

Enhancements

• Added comprehensive description: Expanded the project description to better explain what waitfor does and its use cases
• Added Use Cases section: Documents common scenarios like container orchestration, CI/CD pipelines, development workflows, and health checks
• Added Supported Resource Types section: Clear documentation of all supported resource types (HTTP/HTTPS, PostgreSQL, MySQL, MongoDB, filesystem, process)
• Expanded Quick start section: Added detailed examples for each resource type with practical use cases
• Added Environment Variables section: Shows how to use environment variables instead of command-line flags
• Added Configuration table: Clean table format showing all command-line options with defaults and environment variables
• Improved structure: Better organization with logical flow from description → use cases → supported types → installation → examples → configuration

Examples Added

The README now includes practical examples for:

• HTTP endpoint monitoring
• Database connectivity (PostgreSQL, MySQL, MongoDB)
• Filesystem monitoring (files and directories)
• Process monitoring
• Environment variable configuration
• Multiple resource monitoring

These changes make the documentation much more user-friendly and provide clear guidance for different use cases without modifying any source code.

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.