@@ -5,6 +5,61 @@ All notable changes to the GORM DuckDB driver will be documented in this file.
55The format is based on [ Keep a Changelog] ( https://keepachangelog.com/en/1.0.0/ ) ,
66and this project adheres to [ Semantic Versioning] ( https://semver.org/spec/v2.0.0.html ) .
77
8+ ## [ 0.2.4] - 2025-06-26
9+
10+ ### 📚 Documentation Enhancements
11+
12+ This release focuses on improving user experience with comprehensive installation guidance and enhanced documentation.
13+
14+ ### ✨ Added
15+
16+ - ** 📋 Enhanced Installation Instructions** : Complete step-by-step installation guide with proper ` go.mod ` setup
17+ - ** 🔗 Replace Directive Documentation** : Detailed explanation of the required ` replace ` directive for module path compatibility
18+ - ** 📝 Installation Examples** : Real-world examples showing correct ` go.mod ` configuration
19+ - ** 🚀 Quick Start Improvements** : Streamlined getting-started experience with clear dependency management
20+
21+ ### 📖 Improved
22+
23+ - ** README.md Structure** : Better organization with clear sections for installation, usage, and migration
24+ - ** Module Path Clarity** : Comprehensive explanation of why the replace directive is necessary
25+ - ** Version Reference** : Updated all documentation to reference v0.2.4
26+ - ** User Guidance** : Added notes about seamless migration to official GORM driver once available
27+
28+ ### 🔧 Technical Details
29+
30+ #### Replace Directive Implementation
31+
32+ ``` go
33+ // Required in go.mod for proper functionality
34+ replace gorm.io /driver/duckdb => github.com /greysquirr3l/gorm-duckdb-driver v0.2.4
35+ ```
36+
37+ #### Documentation Structure
38+
39+ - ** Installation Guide** : Step-by-step process with dependency management
40+ - ** Module Configuration** : Clear examples of proper ` go.mod ` setup
41+ - ** Migration Path** : Explanation of future transition to official GORM driver
42+ - ** Compatibility Notes** : Version compatibility and upgrade guidance
43+
44+ ### 🎯 User Experience Improvements
45+
46+ - ** Clearer Setup Process** : Reduced confusion around module installation
47+ - ** Better Onboarding** : New users can get started faster with improved documentation
48+ - ** Version Consistency** : All examples and references updated to v0.2.4
49+ - ** Future Compatibility** : Documentation prepared for eventual official GORM integration
50+
51+ ### 🔄 Breaking Changes
52+
53+ None. This release is fully backward compatible with v0.2.3.
54+
55+ ### 🐛 Fixed
56+
57+ - ** Documentation Gaps** : Filled missing information about proper installation process
58+ - ** Module Path Confusion** : Clarified the relationship between hosted location and module path
59+ - ** Installation Examples** : Corrected and enhanced code examples for better clarity
60+
61+ ---
62+
863## [ 0.2.3] - 2025-06-26
964
1065### 🎉 Major Feature: Production-Ready Array Support
0 commit comments