Skip to content

Commit d6bb8bf

Browse files
committed
Release v0.3.0 - Production Quality
Merge release/v0.3.0 into main for stable v0.3.0 release. Key improvements: - Production quality achieved (Grade A-) - 298 tests (100% passing), 85.4% coverage - Functional options pattern implemented - API convenience methods added - 17 testable examples - 3 critical security fixes - Documentation fully updated
2 parents ddf3359 + 3b9e6eb commit d6bb8bf

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,10 @@ A modern, pure Go library for **reading and writing** MATLAB `.mat` files withou
3636
- Complex numbers
3737
- Multi-dimensional arrays
3838
- Character arrays
39-
- Structures (partial support)
40-
- Cell arrays (partial support)
39+
- Structures
40+
- Cell arrays
41+
- Sparse matrices
42+
- Compressed data (reading)
4143

4244
## Installation
4345

@@ -204,37 +206,36 @@ func main() {
204206
| Numeric arrays |||
205207
| Complex numbers |||
206208
| Character arrays |||
207-
| Multi-dimensional | ⚠️ Partial ||
208-
| Structures | ⚠️ Partial | ⚠️ Partial |
209-
| Cell arrays | ⚠️ Partial | ⚠️ Partial |
210-
| Sparse matrices | | ⚠️ Limited |
211-
| Compression | | |
212-
| Function handles | | |
213-
| Objects | | |
209+
| Multi-dimensional | ||
210+
| Structures | | |
211+
| Cell arrays | | |
212+
| Sparse matrices | | |
213+
| Compression | | |
214+
| Function handles |Out of scope |Out of scope |
215+
| Objects |Out of scope |Out of scope |
214216

215-
### Writer Support (v0.2.0)
217+
### Writer Support
216218

217219
| Feature | v5 (v5-v7.2) | v7.3+ (HDF5) |
218220
|----------------------|--------------|--------------|
219221
| Numeric arrays |||
220222
| Complex numbers |||
221-
| Character arrays | ⚠️ Partial ||
223+
| Character arrays | ||
222224
| Multi-dimensional |||
223225
| Both endianness | ✅ MI/IM | N/A |
224-
| Structures | ❌ Future | ❌ Future |
225-
| Cell arrays | ❌ Future | ❌ Future |
226-
| Compression | ❌ Future | ❌ Future |
226+
| Structures | 📅 v0.5.0+ | 📅 v0.5.0+ |
227+
| Cell arrays | 📅 v0.5.0+ | 📅 v0.5.0+ |
228+
| Compression | 📅 v0.5.0+ | 📅 v0.5.0+ |
227229

228-
## Known Limitations (v0.2.0)
230+
## Known Limitations
229231

230232
### Writer Limitations
231-
- No compression support yet
232-
- No structures/cell arrays writing yet
233-
- Character arrays (partial support for v5 Writer)
233+
- No compression support (planned for v0.5.0+)
234+
- No structures/cell arrays writing (planned for v0.5.0+)
234235

235236
### Reader Limitations
236-
- Limited support for structures and cell arrays
237-
- No compression support
237+
- Function handles not supported (MATLAB-specific, cannot be serialized)
238+
- Objects not supported (language-specific)
238239

239240
### What Works Well ✅
240241
-**v5 Writer COMPLETE** - All numeric types, complex numbers, multi-dimensional arrays
@@ -331,10 +332,10 @@ Contributions are welcome! This is a stable project and we'd love your help.
331332
- 🧪 Test with real MATLAB files and report compatibility
332333

333334
**Priority Areas**:
334-
- Implement v5 writer (TASK-011)
335-
- Fix reader bugs (multi-dimensional arrays, multiple variables)
336-
- Test MATLAB/Octave compatibility
337-
- Improve test coverage (target: 80%+)
335+
- Test MATLAB/Octave compatibility with real-world files
336+
- Add compression support for v5/v7.3 writers
337+
- Implement structures and cell arrays writing
338+
- Improve test coverage (current: 85.4%, target: 90%+)
338339

339340
---
340341

@@ -345,7 +346,7 @@ Contributions are welcome! This is a stable project and we'd love your help.
345346
| Pure Go | ✅ Yes | ❌ CGo required | ✅ Yes |
346347
| v5-v7.2 Read | ✅ Yes | ❌ Limited | ⚠️ Partial |
347348
| v7.3+ Read | ✅ Yes | ❌ No | ❌ No |
348-
| **Write Support** |**v7.3 Yes** | ❌ No | ❌ No |
349+
| **Write Support** |**v5 + v7.3 Yes** | ❌ No | ❌ No |
349350
| Complex Numbers | ✅ Yes | ⚠️ Limited | ❌ No |
350351
| Maintained | ✅ Active | ❌ Inactive | ❌ Inactive |
351352
| Cross-platform | ✅ Yes | ⚠️ Platform-specific | ✅ Yes |
@@ -385,8 +386,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
385386
---
386387

387388
**Status**: ✅ **STABLE** - Production-ready read and write support for both v5 and v7.3 formats!
388-
**Version**: v0.2.0 (stable)
389-
**Last Updated**: 2025-01-09
389+
**Last Updated**: 2025-11-21
390390

391391
**Ready for**: Production use, testing, feedback, and real-world usage
392392
**Stable API**: Minor API changes may occur in 0.x versions, major stability expected

0 commit comments

Comments
 (0)