1.3.1

Author: FranBarInstance

README.md

@@ -40,7 +40,7 @@ How it works
 Neutral TS supports two integration approaches:
 
 ### **Available Modes:**
-- **Rust**: Native library (crate)
+- **Rust**: Native library ([crate](https://crates.io/crates/neutralts)) **or** IPC client ([crate](https://crates.io/crates/neutralipcrs)) + IPC server
 - **Python**: Native package **or** IPC client + IPC server
 - **Other languages** (PHP, etc.): IPC client + IPC server required
 
@@ -61,17 +61,29 @@ Uses the exact same client-server mechanism as a database:
 - **Same principle**: Lightweight client + Powerful server
 - **Universal protocol**: TCP + text/JSON (supported by all languages)
 - **Consistent results**: Same engine processes everything, guaranteeing identical output
+- **Minimal dependencies**: IPC clients are extremely lightweight with minimal external dependencies
+- **Easy updates**: No application recompilation needed - simply update the IPC server for engine improvements
 
 ### **Security Advantage:**
 The IPC architecture provides important security benefits:
 - **Sandboxed execution**: Templates run in isolated processes
 - **Reduced attack surface**: Main application protected from template engine vulnerabilities
 - **Resource control**: Memory and CPU limits can be enforced at server level
 - **Crash containment**: Template engine failures don't affect the main application
+- **Zero-downtime updates**: IPC server can be updated independently without restarting client applications
 
 ### **Key Advantage:**
 Just like an SQL query returns the same data from any language, a Neutral TS template returns the same HTML from Python, PHP, Rust... with added security isolation.
 
+### **Performance Consideration:**
+The IPC approach introduces performance overhead due to inter-process communication. The impact varies depending on:
+
+- Application type
+- Programming language
+- Network latency
+
+For most web applications, the security and interoperability benefits compensate for the performance overhead.
+
 ### **IPC Components:**
 - **IPC Server**: Universal standalone application (written in Rust) for all languages - download from: [IPC Server](https://github.com/FranBarInstance/neutral-ipc/releases)
 - **IPC Clients**: Language-specific libraries to include in your project - available at: [IPC Clients](https://github.com/FranBarInstance/neutral-ipc/tree/master/clients)
@@ -450,6 +462,8 @@ Or for array:
 Native use (Rust)
 -----------------
 
+Alternatively, you can use: [Neutral TS Rust IPC Client](https://crates.io/crates/neutralipcrs)
+
 ```text
 use neutralts::Template;
 use serde_json::json;
@@ -468,6 +482,8 @@ let status_param = template.get_status_param();
 
 // act accordingly at this point according to your framework
 ```
+[Rust examples](https://github.com/FranBarInstance/neutralts-docs/tree/master/examples/rust)
+
 
 Python - Package
 ----------------
@@ -493,12 +509,14 @@ status_param = template.get_status_param()
 
 # act accordingly at this point according to your framework
 ```
+[Python examples](https://github.com/FranBarInstance/neutralts-docs/tree/master/examples/python)
+
 
 Python - IPC
 ------------
 
 - Requires the IPC server: [Neutral TS IPC Server](https://github.com/FranBarInstance/neutral-ipc/releases)
-- Requires the Python IPC client: [Neutral TS IPC Clients](https://github.com/FranBarInstance/neutral-ipc/clients)
+- Requires the Python IPC client: [Neutral TS IPC Clients](https://github.com/FranBarInstance/neutral-ipc)
 
 ```text
 from NeutralIpcTemplate import NeutralIpcTemplate
@@ -517,33 +535,35 @@ status_param = template.get_status_param()
 
 # act accordingly at this point according to your framework
 ```
+[Python examples](https://github.com/FranBarInstance/neutralts-docs/tree/master/examples/python)
+
 
 PHP
 ---
 
 - Requires the IPC server: [Neutral TS IPC Server](https://github.com/FranBarInstance/neutral-ipc/releases)
-- Requires the Python IPC client: [Neutral TS IPC Clients](https://github.com/FranBarInstance/neutral-ipc/clients)
+- Requires the PHP IPC client: [Neutral TS IPC Clients](https://github.com/FranBarInstance/neutral-ipc)
 
+[PHP examples](https://github.com/FranBarInstance/neutralts-docs/tree/master/examples/php)
 
-```text
-include 'NeutralIpcTemplate.php';
+Node.js
+-------
 
-$template = new NeutralIpcTemplate("file.ntpl", $schema);
-$contents = $template->render();
+- Requires the IPC server: [Neutral TS IPC Server](https://github.com/FranBarInstance/neutral-ipc/releases)
+- Requires the Node IPC client: [Neutral TS IPC Clients](https://github.com/FranBarInstance/neutral-ipc)
 
-// e.g.: 200
-$status_code = $template->get_status_code();
+[Node.js examples](https://github.com/FranBarInstance/neutralts-docs/tree/master/examples/node)
 
-// e.g.: OK
-$status_text = $template->get_status_text();
+Go
+--
 
-// empty if no error
-$status_param = $template->get_status_param();
+- Requires the IPC server: [Neutral TS IPC Server](https://github.com/FranBarInstance/neutral-ipc/releases)
+- Requires the Go IPC client: [Neutral TS IPC Clients](https://github.com/FranBarInstance/neutral-ipc)
 
-// act accordingly at this point according to your framework
-```
+[Go examples](https://github.com/FranBarInstance/neutralts-docs/tree/master/examples/go)
 
-Neutral TS template engine.
+Neutral TS template engine
+--------------------------
 
 - [Rust docs](https://docs.rs/neutralts/latest/neutralts/)
 - [Template docs](https://franbarinstance.github.io/neutralts-docs/docs/neutralts/doc/)

docs/README.md

@@ -40,7 +40,7 @@ How it works
 Neutral TS supports two integration approaches:
 
 ### **Available Modes:**
-- **Rust**: Native library (crate)
+- **Rust**: Native library ([crate](https://crates.io/crates/neutralts)) **or** IPC client ([crate](https://crates.io/crates/neutralipcrs)) + IPC server
 - **Python**: Native package **or** IPC client + IPC server
 - **Other languages** (PHP, etc.): IPC client + IPC server required
 
@@ -61,17 +61,29 @@ Uses the exact same client-server mechanism as a database:
 - **Same principle**: Lightweight client + Powerful server
 - **Universal protocol**: TCP + text/JSON (supported by all languages)
 - **Consistent results**: Same engine processes everything, guaranteeing identical output
+- **Minimal dependencies**: IPC clients are extremely lightweight with minimal external dependencies
+- **Easy updates**: No application recompilation needed - simply update the IPC server for engine improvements
 
 ### **Security Advantage:**
 The IPC architecture provides important security benefits:
 - **Sandboxed execution**: Templates run in isolated processes
 - **Reduced attack surface**: Main application protected from template engine vulnerabilities
 - **Resource control**: Memory and CPU limits can be enforced at server level
 - **Crash containment**: Template engine failures don't affect the main application
+- **Zero-downtime updates**: IPC server can be updated independently without restarting client applications
 
 ### **Key Advantage:**
 Just like an SQL query returns the same data from any language, a Neutral TS template returns the same HTML from Python, PHP, Rust... with added security isolation.
 
+### **Performance Consideration:**
+The IPC approach introduces performance overhead due to inter-process communication. The impact varies depending on:
+
+- Application type
+- Programming language
+- Network latency
+
+For most web applications, the security and interoperability benefits compensate for the performance overhead.
+
 ### **IPC Components:**
 - **IPC Server**: Universal standalone application (written in Rust) for all languages - download from: [IPC Server](https://github.com/FranBarInstance/neutral-ipc/releases)
 - **IPC Clients**: Language-specific libraries to include in your project - available at: [IPC Clients](https://github.com/FranBarInstance/neutral-ipc/tree/master/clients)
@@ -450,6 +462,8 @@ Or for array:
 Native use (Rust)
 -----------------
 
+Alternatively, you can use: [Neutral TS Rust IPC Client](https://crates.io/crates/neutralipcrs)
+
 ```text
 use neutralts::Template;
 use serde_json::json;
@@ -468,6 +482,8 @@ let status_param = template.get_status_param();
 
 // act accordingly at this point according to your framework
 ```
+[Rust examples](https://github.com/FranBarInstance/neutralts-docs/tree/master/examples/rust)
+
 
 Python - Package
 ----------------
@@ -493,12 +509,14 @@ status_param = template.get_status_param()
 
 # act accordingly at this point according to your framework
 ```
+[Python examples](https://github.com/FranBarInstance/neutralts-docs/tree/master/examples/python)
+
 
 Python - IPC
 ------------
 
 - Requires the IPC server: [Neutral TS IPC Server](https://github.com/FranBarInstance/neutral-ipc/releases)
-- Requires the Python IPC client: [Neutral TS IPC Clients](https://github.com/FranBarInstance/neutral-ipc/clients)
+- Requires the Python IPC client: [Neutral TS IPC Clients](https://github.com/FranBarInstance/neutral-ipc)
 
 ```text
 from NeutralIpcTemplate import NeutralIpcTemplate
@@ -517,33 +535,35 @@ status_param = template.get_status_param()
 
 # act accordingly at this point according to your framework
 ```
+[Python examples](https://github.com/FranBarInstance/neutralts-docs/tree/master/examples/python)
+
 
 PHP
 ---
 
 - Requires the IPC server: [Neutral TS IPC Server](https://github.com/FranBarInstance/neutral-ipc/releases)
-- Requires the Python IPC client: [Neutral TS IPC Clients](https://github.com/FranBarInstance/neutral-ipc/clients)
+- Requires the PHP IPC client: [Neutral TS IPC Clients](https://github.com/FranBarInstance/neutral-ipc)
 
+[PHP examples](https://github.com/FranBarInstance/neutralts-docs/tree/master/examples/php)
 
-```text
-include 'NeutralIpcTemplate.php';
+Node.js
+-------
 
-$template = new NeutralIpcTemplate("file.ntpl", $schema);
-$contents = $template->render();
+- Requires the IPC server: [Neutral TS IPC Server](https://github.com/FranBarInstance/neutral-ipc/releases)
+- Requires the Node IPC client: [Neutral TS IPC Clients](https://github.com/FranBarInstance/neutral-ipc)
 
-// e.g.: 200
-$status_code = $template->get_status_code();
+[Node.js examples](https://github.com/FranBarInstance/neutralts-docs/tree/master/examples/node)
 
-// e.g.: OK
-$status_text = $template->get_status_text();
+Go
+--
 
-// empty if no error
-$status_param = $template->get_status_param();
+- Requires the IPC server: [Neutral TS IPC Server](https://github.com/FranBarInstance/neutral-ipc/releases)
+- Requires the Go IPC client: [Neutral TS IPC Clients](https://github.com/FranBarInstance/neutral-ipc)
 
-// act accordingly at this point according to your framework
-```
+[Go examples](https://github.com/FranBarInstance/neutralts-docs/tree/master/examples/go)
 
-Neutral TS template engine.
+Neutral TS template engine
+--------------------------
 
 - [Rust docs](https://docs.rs/neutralts/latest/neutralts/)
 - [Template docs](https://franbarinstance.github.io/neutralts-docs/docs/neutralts/doc/)

docs/help.html

@@ -1 +1 @@
-<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Documentation for Rustdoc"><title>Help</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="./static.files/${f}">`).join(""))</script><link rel="stylesheet" href="./static.files/normalize-9960930a.css"><link rel="stylesheet" href="./static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="./" data-static-root-path="./static.files/" data-current-crate="neutralts" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="./static.files/storage-59e33391.js"></script><script defer src="./static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="./static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="./static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="./static.files/favicon-044be391.svg"></head><body class="rustdoc mod sys"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="./index.html"><img class="rust-logo" src="./static.files/rust-logo-9a9549ea.svg" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="./index.html"><img class="rust-logo" src="./static.files/rust-logo-9a9549ea.svg" alt="logo"></a><h2><a href="./index.html">Rustdoc</a><span class="version">1.84.1</span></h2></div><div class="version">(e71f9a9a9 2025-01-27)</div><h2 class="location">Help</h2><div class="sidebar-elems"></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Rustdoc help</h1><span class="out-of-band"><a id="back" href="javascript:void(0)" onclick="history.back();">Back</a></span></div><noscript><section><p>You need to enable JavaScript to use keyboard commands or search.</p><p>For more information, browse the <a href="https://doc.rust-lang.org/rustdoc/">rustdoc handbook</a>.</p></section></noscript></section></div></main></body></html>
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Documentation for Rustdoc"><title>Help</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="./static.files/${f}">`).join(""))</script><link rel="stylesheet" href="./static.files/normalize-9960930a.css"><link rel="stylesheet" href="./static.files/rustdoc-84e720fa.css"><meta name="rustdoc-vars" data-root-path="./" data-static-root-path="./static.files/" data-current-crate="neutralts" data-themes="" data-resource-suffix="" data-rustdoc-version="1.89.0 (29483883e 2025-08-04)" data-channel="1.89.0" data-search-js="search-92309212.js" data-settings-js="settings-5514c975.js" ><script src="./static.files/storage-4e99c027.js"></script><script defer src="./static.files/main-fd3af306.js"></script><noscript><link rel="stylesheet" href="./static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="./static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="./static.files/favicon-044be391.svg"></head><body class="rustdoc mod sys"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="./index.html"><img class="rust-logo" src="./static.files/rust-logo-9a9549ea.svg" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="./index.html"><img class="rust-logo" src="./static.files/rust-logo-9a9549ea.svg" alt="logo"></a><h2><a href="./index.html">Rustdoc</a><span class="version">1.89.0</span></h2></div><div class="version">(29483883e 2025-08-04)</div><h2 class="location">Help</h2><div class="sidebar-elems"></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Rustdoc help</h1><span class="out-of-band"><a id="back" href="javascript:void(0)" onclick="history.back();">Back</a></span></div><noscript><section><p>You need to enable JavaScript to use keyboard commands or search.</p><p>For more information, browse the <a href="https://doc.rust-lang.org/1.89.0/rustdoc/">rustdoc handbook</a>.</p></section></noscript></section></div></main></body></html>