diff --git a/CHANGELOG.md b/CHANGELOG.md index dcca594..f703358 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## 1.2.1 + +- Clarify the safe shared-response and fixed-slot borrowed-response helpers so + embedded web clients can choose the ownership model that matches their + response lifetime. +- Refresh the package documentation and canonical PlatformIO installation tag. + ## 1.2.0 - Add a borrowed async-response helper for fixed, caller-owned response slots. It avoids a per-request `shared_ptr` control allocation while releasing the slot safely on completion or disconnect. diff --git a/README.md b/README.md index 18126be..0dc2226 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Device Framework Template Engine +# DeviceFramework Template Engine (DFTE) DFTE streams HTML and text from ESP8266 and ESP32 firmware without constructing a complete response in RAM. Store layouts in PROGMEM, resolve changing values through getters, and render fixed-size chunks directly to serial or an asynchronous HTTP response. @@ -49,7 +49,7 @@ Build [Hello Placeholder](examples/HelloPlaceholder/) to see the rendered result ```ini lib_deps = - DeviceFrameworkTemplateEngine=https://github.com/alexhopeoconnor/DFTE.git#v1.2.0 + DeviceFrameworkTemplateEngine=https://github.com/alexhopeoconnor/DFTE.git#v1.2.1 ``` PlatformIO checks out the Git ref after `#`; GitHub Release assets are unrelated. DFTE supports ESP8266 and ESP32 Arduino projects. diff --git a/docs/ASYNC_WEB.md b/docs/ASYNC_WEB.md index 9822ce6..eb4a937 100644 --- a/docs/ASYNC_WEB.md +++ b/docs/ASYNC_WEB.md @@ -2,6 +2,11 @@ Build a `PlaceholderRegistry` once during setup, but allocate a fresh `TemplateContext` for each request. A shared context would mix rendering state when clients overlap. +| Need | Use | +| --- | --- | +| A request-owned dynamic render context | `beginSafeTemplateResponse()` | +| A fixed response-slot pool owned by the application | `beginBorrowedChunkedResponse()` | + ```cpp #include #include diff --git a/docs/README.md b/docs/README.md index 44efc89..839d5b8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# DFTE documentation +# DeviceFramework Template Engine (DFTE) documentation | I want to… | Read | | --- | --- | diff --git a/library.json b/library.json index 3dd8650..80d30d9 100644 --- a/library.json +++ b/library.json @@ -1,6 +1,6 @@ { "name": "DeviceFrameworkTemplateEngine", - "version": "1.2.0", + "version": "1.2.1", "description": "Memory-efficient streaming template engine for ESP8266/ESP32 with chunked rendering support. Designed for embedded web interfaces with PROGMEM template support.", "keywords": [ "template",