Add comprehensive README and CONTRIBUTING guidelines #30
Description
The repository needs clear documentation to help users understand the project and guide potential contributors through the contribution process.
Requirements:
README.md should include:
- Project title and description
- Installation instructions
- Usage examples
- API documentation
- Configuration options
- Prerequisites and system requirements
- License information
- Badges (build status, version, etc.)
- Links to additional documentation
CONTRIBUTING.md should include:
- How to report bugs and request features
- Development setup instructions
- Code style guidelines and standards
- Testing requirements
- Pull request process and review
- Commit message conventions