doc: update React-related documentation

bpolaszek · Nov 29, 2023 · da3307b · da3307b
1 parent ade9f45
commit da3307b
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ Table of Contents
     - [Chaining extractors / transformers / loaders](doc/advanced_usage.md#chaining-extractors--transformers--loaders)
     - [Reading from STDIN / Writing to STDOUT](doc/advanced_usage.md#reading-from-stdin--writing-to-stdout)
     - [Instantiators](doc/advanced_usage.md#instantiators)
-    - [Using React Streams (ReactPHP support)](doc/advanced_usage.md#using-react-streams-experimental)
+    - [Using ReactPHP](doc/advanced_usage.md#using-reactphp-experimental)
 - [Recipes](doc/recipes.md)
 - [Contributing](#contribute)
 - [License](#license)

diff --git a/doc/advanced_usage.md b/doc/advanced_usage.md
@@ -159,10 +159,18 @@ $report = withRecipe(new LoggerRecipe($logger))
     ->process(['foo', 'bar']);
 ```
 
-Using React streams (experimental)
+Using ReactPHP (experimental)
 ----------------------------------
 
-You can plug your ETL dataflows to any [React Stream](https://github.com/reactphp/stream).
+By using the `ReactStreamProcessor` recipe, you can use ReactPHP as the processor of your data.
+
+You can use any [React Stream](https://github.com/reactphp/stream) or `iterable`: each item will be iterated 
+using a [Loop tick](https://github.com/reactphp/event-loop#futuretick) instead of a blocking `while` loop.
+
+This allows you, for example, to: 
+- [Periodically](https://github.com/reactphp/event-loop#addperiodictimer) perform some stuff (with `Loop::addPeriodicTimer()`)
+- Handle [POSIX signals](https://github.com/reactphp/event-loop#addsignal) (with `Loop::addSignal()`)
+- Use [React streams](https://github.com/reactphp/stream) for an event-oriented approach.
 
 Example with a TCP server: