feat: Add comprehensive documentation and enhance library features

- Add complete API documentation for all public interfaces
- Implement comprehensive README with usage examples and best practices
- Add thread safety documentation and implementation notes
- Document all core components: APIClient, NetworkRouter, NetworkError
- Add detailed documentation for RetryHandler and DefaultRetryHandler
- Document SendablePromise with thread safety examples
- Add APIVersion documentation with usage patterns
- Document Data extensions with practical examples
- Add comprehensive NetworkParameterEncoding documentation
- Document HeaderHandler with type-safe header management

Author: siamakrostami

Package.swift

@@ -1,6 +1,36 @@
 // swift-tools-version: 6.0
 import PackageDescription
 
+/// SRNetworkManager - A comprehensive networking library for Swift applications
+/// 
+/// This package provides a robust, thread-safe networking solution with support for:
+/// - Combine and async/await programming models
+/// - Automatic retry mechanisms with customizable strategies
+/// - Request/response logging with configurable levels
+/// - File upload with progress tracking
+/// - Streaming responses
+/// - Network reachability monitoring
+/// - VPN detection
+/// - Multipart form data handling
+/// - Custom error handling and mapping
+/// - Thread-safe operations with proper synchronization
+///
+/// ## Supported Platforms
+/// - iOS 13.0+
+/// - macOS 13.0+
+/// - tvOS 13.0+
+/// - watchOS 7.0+
+///
+/// ## Key Features
+/// - **Dual Programming Models**: Support for both Combine and async/await
+/// - **Thread Safety**: All operations are thread-safe with proper synchronization
+/// - **Retry Logic**: Configurable retry strategies for failed requests
+/// - **Logging**: Comprehensive request/response logging with multiple levels
+/// - **Upload Support**: File upload with progress tracking
+/// - **Streaming**: Support for streaming responses
+/// - **Network Monitoring**: Real-time network connectivity and VPN detection
+/// - **Error Handling**: Rich error types with proper mapping
+/// - **Parameter Encoding**: Support for JSON, URL-encoded, and multipart form data
 let package = Package(
     name: "SRNetworkManager",
     platforms: [
@@ -20,21 +50,21 @@ let package = Package(
             name: "SRNetworkManager",
             path: "Sources",
             sources: [
-                "SRNetworkManager",
-                "HeaderHandler",
-                "Encoding",
-                "Log",
-                "Mime",
-                "Error",
-                "Client",
-                "UploadProgress",
-                "Router",
-                "Data",
-                "Reachability"
+                "SRNetworkManager",      // Main network manager interface
+                "HeaderHandler",         // HTTP header management
+                "Encoding",              // Parameter encoding (JSON, URL, multipart)
+                "Log",                   // Request/response logging
+                "Mime",                  // MIME type detection
+                "Error",                 // Network error definitions
+                "Client",                // Core API client implementation
+                "UploadProgress",        // Upload progress tracking
+                "Router",                // Network routing and URL construction
+                "Data",                  // Data extensions and utilities
+                "Reachability"           // Network connectivity monitoring
             ],
             swiftSettings: [
-                .define("SPM_SWIFT_6"),
-                .define("SWIFT_PACKAGE")
+                .define("SPM_SWIFT_6"),  // Swift 6 compatibility flag
+                .define("SWIFT_PACKAGE") // Package manager flag
             ]
         ),
         .testTarget(
@@ -43,5 +73,5 @@ let package = Package(
             path: "Tests/SRNetworkManagerTests"
         ),
     ],
-    swiftLanguageModes: [.v6,.v5]
+    swiftLanguageModes: [.v6,.v5]  // Support for both Swift 5 and 6
 )