Initial work towards compiler plugin support: Update docs and add test placeholder

[vidishagawas121]

Initial work towards compiler plugin support

This PR lays the groundwork for adding compiler plugin support to Scaladex by improving documentation and setting up test placeholders.

Changes Made

Documentation Updates

1. Updated README.md:

   • Added comprehensive list of supported binary version formats
   • Added section about compiler plugin support
   • Provided guidance for users with compiler plugins
   • Improved binary version documentation

2. Enhanced BinaryVersion.scala:

   • Added detailed class documentation
   • Included examples of different binary version formats
   • Added TODO section outlining steps for compiler plugin support implementation
   • Documented required changes for full version number support

3. Added Test Infrastructure:

   • Created test placeholder in BinaryVersionTests.scala
   • Added example test cases for future implementation
   • Prepared test scenarios for compiler plugin version parsing

Implementation Plan

The following steps are planned for full compiler plugin support:

1. Extend the Platform type to include CompilerPlugin
2. Update the Parser to handle full version numbers (e.g., _2.13.10)
3. Modify the artifact indexing logic to recognize compiler plugin artifacts

Related Information

This work is part of a larger effort to improve Scaladex's support for compiler plugins, which currently use full Scala versions (e.g., _2.13.10) and require special handling.

Testing

• No functionality changes in this PR
• Added placeholder tests that will be implemented in future PRs
• Documentation changes have been reviewed for accuracy

Checklist

• Updated documentation
• Added test placeholders
• Maintained code formatting
• No breaking changes

[vidishagawas121]

@adpi2 @kannukalra this is a small initial PR to help understand the codebase for GSoC 2025 project idea (https://github.com/scalacenter/scaladex/)