From 5834721da878462783a7498b51b35f7c2d506fe2 Mon Sep 17 00:00:00 2001 From: Juergen Kunz Date: Mon, 24 Nov 2025 13:09:00 +0000 Subject: [PATCH] fix(readme): Update README to document 3.0.0+ changes: architecture refactor, streaming improvements, health check and circular dependency fixes --- changelog.md | 11 +++++++++++ readme.md | 16 +++++++++------- ts/00_commitinfo_data.ts | 2 +- 3 files changed, 21 insertions(+), 8 deletions(-) diff --git a/changelog.md b/changelog.md index 98c972b..7b1b955 100644 --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,16 @@ # Changelog +## 2025-11-24 - 3.0.2 - fix(readme) +Update README to document 3.0.0+ changes: architecture refactor, streaming improvements, health check and circular dependency fixes + +- Documented major refactor to a Clean OOP / Facade pattern with DockerHost as the single entry point +- Added/clarified real-time container streaming APIs: streamLogs(), attach(), exec() +- Clarified support for flexible descriptors (accept both string references and class instances) +- Documented complete container lifecycle API (start, stop, remove, logs, inspect, stats) +- Documented new ping() health check method to verify Docker daemon availability +- Noted fix for circular dependency issues in Node.js by using type-only imports +- Mentioned improved TypeScript definitions and expanded examples, migration guides, and real-world use cases + ## 2025-11-24 - 3.0.1 - fix(classes.base) Use type-only import for DockerHost in classes.base to avoid runtime side-effects diff --git a/readme.md b/readme.md index e39315f..34585b8 100644 --- a/readme.md +++ b/readme.md @@ -904,15 +904,17 @@ async function healthCheckService() { ## 🆕 Recent Updates -### Version 2.1.0 - Architecture & Features +### Version 3.0.0+ - Architecture & Stability - ✨ **Clean OOP Architecture**: Refactored to Facade pattern with DockerHost as single entry point -- ✨ **Container Streaming**: Added `streamLogs()`, `attach()`, and `exec()` methods -- ✨ **Flexible Descriptors**: Support both string references and class instances -- ✨ **Complete Container API**: All lifecycle methods (start, stop, remove, logs, inspect, stats) -- ✨ **DockerResource Base Class**: Consistent patterns across all resources -- 🔧 **Improved Type Safety**: Better TypeScript definitions throughout -- 📚 **Enhanced Documentation**: Comprehensive examples and migration guides +- ✨ **Container Streaming**: Real-time `streamLogs()`, `attach()`, and `exec()` methods for interactive containers +- ✨ **Flexible Descriptors**: Support both string references and class instances in all creation methods +- ✨ **Complete Container API**: Full lifecycle methods (start, stop, remove, logs, inspect, stats) +- ✨ **DockerResource Base Class**: Consistent patterns and type safety across all resources +- ✨ **Health Check Support**: New `ping()` method to verify Docker daemon availability +- 🐛 **Fixed Circular Dependencies**: Resolved Node.js module loading issues with type-only imports +- 🔧 **Improved Type Safety**: Better TypeScript definitions and interfaces throughout +- 📚 **Enhanced Documentation**: Comprehensive examples, migration guides, and real-world use cases ## License and Legal Information diff --git a/ts/00_commitinfo_data.ts b/ts/00_commitinfo_data.ts index d3fa571..7095cf7 100644 --- a/ts/00_commitinfo_data.ts +++ b/ts/00_commitinfo_data.ts @@ -3,6 +3,6 @@ */ export const commitinfo = { name: '@apiclient.xyz/docker', - version: '3.0.1', + version: '3.0.2', description: 'Provides easy communication with Docker remote API from Node.js, with TypeScript support.' }