Overview

This PR addresses the issue where users found it difficult to understand what Plexus Archiver is and how it compares to Apache Commons Compress, especially why one should choose Plexus Archiver over Commons Compress.

Changes

Updated README.md to include:

1. Introduction Section

Added a "What is Plexus Archiver?" section that clearly describes Plexus Archiver as a high-level Java API for creating and extracting archives with a simple, unified interface.

2. Comprehensive Comparison Section

Added a detailed "Comparison to Apache Commons Compress" section that explains:

• The Relationship: Plexus Archiver builds on top of Apache Commons Compress (since version 2.5) as a higher-level abstraction layer
• Commons Compress Capabilities: What the low-level library provides (direct format access, fine-grained control, streaming API, etc.)
• Plexus Archiver Advantages: What the higher-level abstraction adds:
  • Simplified, builder-style API
  • Advanced features like file selectors, reproducible builds, duplicate handling, file mappers, and ZIP bomb protection
  • Build tool integration with modular JAR creation and manifest handling
  • Dependency injection readiness with JSR-330 annotations

3. Decision Guide

Added a "When to Use Which?" section with clear guidance:

• Use Commons Compress when you need fine-grained control, streaming data handling, or specialized formats
• Use Plexus Archiver when you want a simple API, are building Maven plugins, need reproducible builds, or want built-in file filtering

Benefits

• Users can now quickly understand the purpose and value proposition of Plexus Archiver
• The documentation clarifies that Plexus Archiver complements rather than replaces Commons Compress
• Developers can make informed decisions about which library to use for their use case
• All mentioned features are supported by the actual codebase (verified through code inspection and release notes)

Fixes #[issue number]

💡 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.