Updated documentations

docs/installation.md

@@ -2,9 +2,10 @@
 
 - [⬅️️ Back](introduction.md)
 
-This repository is a [monorepo](https://tomasvotruba.com/blog/2019/10/28/all-you-always-wanted-to-know-about-monorepo-but-were-afraid-to-ask/).
-Please check the below packages and select only those that you are going to use,
-this will reduce the number of unnecessary dependencies in your project (less maintenance).
+Flow is developed as a [monorepo](https://tomasvotruba.com/blog/2019/10/28/all-you-always-wanted-to-know-about-monorepo-but-were-afraid-to-ask/) in order
+to reduce maintenance overhead and to make it easier to manage dependencies between components. 
+
+Instead of installing whole repository with all dependencies, it's recommended to install only the components you need.
 
 - [ETL](components/core/core.md)
 - Adapters

src/adapter/etl-adapter-avro/README.md

@@ -5,5 +5,9 @@ If you are interested in this integration, please let us know by creating an iss
 
 At some point in the future, we are going to write our own Avro library for PHP, but it is not a priority at the moment.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/adapters/avro.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/adapter/etl-adapter-chartjs/README.md

@@ -12,5 +12,9 @@ data visualization in large-scale and data-intensive environments. With Flow PHP
 rendering and interaction within your ETL workflows becomes a more refined and efficient endeavor, harmoniously aligning
 with the robust and adaptable framework of the Flow PHP ecosystem.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/adapters/chartjs.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/adapter/etl-adapter-csv/README.md

@@ -11,5 +11,9 @@ making it a prime choice for developers dealing with CSV data in large-scale and
 PHP's Adapter CSV, managing CSV data within your ETL workflows becomes a more simplified and efficient task, perfectly
 aligning with the robust and adaptable framework of the Flow PHP ecosystem.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/adapters/csv.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/adapter/etl-adapter-doctrine/README.md

@@ -12,5 +12,9 @@ operations in large-scale and data-intensive environments. With Flow PHP's Adapt
 interactions within your ETL workflows becomes a more simplified and efficient endeavor, perfectly aligning with the
 robust and adaptable nature of the Flow PHP ecosystem.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/adapters/doctrine.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/adapter/etl-adapter-elasticsearch/README.md

@@ -12,5 +12,9 @@ making it an excellent choice for developers dealing with Elasticsearch in large
 With Flow PHP's Adapter Elasticsearch, managing Elasticsearch data within your ETL workflows becomes a more refined and
 efficient endeavor, harmoniously aligning with the robust and adaptable framework of the Flow PHP ecosystem.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/adapters/elasticsearch.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/adapter/etl-adapter-google-sheet/README.md

@@ -12,5 +12,9 @@ developers dealing with Google Sheets in large-scale and data-intensive projects
 managing Google Sheets data within your ETL workflows becomes a more simplified and efficient task, perfectly aligning
 with the robust and adaptable nature of the Flow PHP ecosystem.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/adapters/google-sheet.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/adapter/etl-adapter-http/README.md

@@ -12,5 +12,9 @@ large-scale and data-intensive environments. With Flow PHP's Adapter HTTP, navig
 workflows becomes a more refined and efficient endeavor, harmoniously aligning with the robust and adaptable framework
 of the Flow PHP ecosystem.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/adapters/http.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/adapter/etl-adapter-json/README.md

@@ -11,5 +11,9 @@ data processing solutions, making it a prime choice for developers dealing with
 data-intensive environments. With Flow PHP's Adapter JSON, managing JSON data within your ETL workflows becomes a more
 simplified and efficient task, perfectly aligning with the robust and adaptable nature of the Flow PHP ecosystem.
 
-- 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/adapters/json.md)
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
+- 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/adapters/json.md)\
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/adapter/etl-adapter-logger/README.md

@@ -2,5 +2,9 @@
 
 ETL Adapter that provides PSR Logger support for ETL.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/adapters/logger.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/adapter/etl-adapter-meilisearch/README.md

@@ -13,5 +13,9 @@ indexing operations in large-scale and data-intensive environments. With Flow PH
 search and indexing tasks within your ETL workflows becomes a more streamlined and efficient endeavor, harmoniously
 aligning with the robust and adaptable framework of the Flow PHP ecosystem.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/adapters/meilisearch.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/adapter/etl-adapter-parquet/README.md

@@ -12,5 +12,9 @@ for developers dealing with Parquet data in large-scale and data-intensive scena
 managing Parquet data within your ETL workflows becomes a more simplified and efficient task, perfectly aligning with
 the robust and adaptable nature of the Flow PHP ecosystem.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/adapters/parquet.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/adapter/etl-adapter-text/README.md

@@ -12,5 +12,9 @@ text data in large-scale and data-intensive projects. With Flow PHP's Adapter Te
 workflows becomes a more refined and efficient endeavor, perfectly aligning with the robust and adaptable framework of
 the Flow PHP ecosystem.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/adapters/text.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/adapter/etl-adapter-xml/README.md

@@ -11,5 +11,9 @@ making it a prime choice for developers dealing with XML data in large-scale and
 PHP's Adapter XML, managing XML data within your ETL workflows becomes a more simplified and efficient endeavor,
 aligning perfectly with the robust and adaptable nature of the Flow PHP ecosystem.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/adapters/xml.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/bridge/filesystem/azure/README.md

@@ -1,6 +1,10 @@
-# Dremel
+# Filesystem Azure Bridge
 
-## Installation
+This package provides a bridge between the [Filesystem](https::/github.com/flow-php/filesystem) and the [Flow Azure SDK](https://github.com/flow-php/azure-sdk) library. 
+
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
 
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/bridges/filesystem-azure-bridge.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/bridge/monolog/http/README.md

@@ -1,6 +1,12 @@
-# Dremel
+# Monolog HTTP Bridge
 
-## Installation
+This package provides a set of components to integrate Monolog logger with PSR-7 HTTP messages.
+By using this bridge, you can log request/response data Monolog LogRecord context. 
+Request/Response objects will be normalized and formatted according to defined configuration.
+
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
 
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/bridges/monolog-http-bridge.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/core/etl/README.md

@@ -12,5 +12,9 @@ for managing large-scale data processing tasks and building scalable web systems
 Whether you are dealing with data transformation or orchestrating complex data flows, Flow PHP is tailored to meet the
 demands of modern web infrastructures.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/core/core.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/lib/array-dot/README.md

@@ -10,5 +10,9 @@ it a valuable asset for developers aiming to streamline their array handling tas
 configuration data, nested JSON objects, or any other complex array structures, the Array Dot library is a reliable
 companion for achieving cleaner and more efficient array operations.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/libs/array-dot.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/lib/azure-sdk/README.md

@@ -1,6 +1,12 @@
-# Dremel
+# Azure SDK
 
-## Installation
+Lightweight, dependency-free and modular SDK for Azure services based on PSR contracts.
+This SDK was designed and optimized to handle Azure Blob Storage in the most optimal way. 
+The main goal is to provide a integration between Flow Filesystem and Azure Blob Storage.
+
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
 
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/libs/azure-sdk.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/lib/doctrine-dbal-bulk/README.md

@@ -9,5 +9,9 @@ reliability even in demanding data-intensive environments. This aligns perfectly
 processing, making the Doctrine DBAL Bulk library an invaluable addition to your data transformation and processing
 toolkit.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/libs/doctrine-dbal-bulk.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/lib/dremel/README.md

@@ -1,6 +1,11 @@
 # Dremel
 
-## Installation
+Dremel is a library that provides pure PHP implementation of two algorithms described in the paper "Dremel: Interactive Analysis of Web-Scale Datasets". 
+The algorithms are used to shred and assemble nested data structures in a columnar format.
+
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
 
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/libs/dremel.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/lib/filesystem/README.md

@@ -1,6 +1,15 @@
-# Dremel
+# Filesystem
 
-## Installation
+Flow Filesystem is a simple abstraction for streaming remote/local files.  
+
+The main goals of this library are:
+
+- read files from remote/local storages by byte ranges
+- write files to remote/local storages in chunks
+
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
 
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/libs/filesystem.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/lib/filesystem/composer.json

@@ -14,7 +14,8 @@
         "gcp"
     ],
     "require": {
-        "php": "~8.1.0 || ~8.2.0 || ~8.3.0"
+        "php": "~8.1.0 || ~8.2.0 || ~8.3.0",
+        "webmozart/glob": "^3.0 || ^4.0"
     },
     "config": {
         "optimize-autoloader": true,

src/lib/parquet-viewer/README.md

@@ -1,6 +1,12 @@
 # Parquet Viewer
 
-## Installation
+This package provides a simple CLI viewer for Parquet files. 
+Since parquet is a binary format, it's not human-readable that's why this package is useful for debugging and testing purposes.
+We can read and display parquet files data but also metadata like schema, row groups, and columns.
+
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
 
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/libs/parquet-viewer.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/lib/parquet/README.md

@@ -1,6 +1,11 @@
 # Parquet
 
-## Installation
+Parquet is a columnar storage file format that provides efficient data compression and encoding schemes with enhanced performance to handle complex data in bulk.
+This library is a pure PHP implementation of the Parquet file format, enabling developers to read and write Parquet files without relying on external dependencies.
+
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
 
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/libs/parquet.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/lib/rdsl/README.md

@@ -1,8 +1,11 @@
 # Remote DSL 
 
 Remote Domain Specific Language 
-This library allows to execute a DSL functions defined in JSON (and possibly more) format on a remote server.
+This library allows executing a DSL functions defined in JSON (and possibly more) format on a remote server.
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
 
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/libs/rdsl.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)

src/lib/snappy/README.md

@@ -6,5 +6,9 @@ This library is a port of javascript [snappyjs](https://github.com/zhipeng-jia/s
 Whenever it's possible, it's recommended to install [PHP Extension.](https://github.com/kjdev/php-ext-snappy)
 Otherwise, this lib will register polyfill functions. 
 
+> [!IMPORTANT]  
+> This repository is a subtree split from our monorepo. If you'd like to contribute, please visit our main monorepo [flow-php/flow](https://github.com/flow-php/flow).
+
 - 📜 [Documentation](https://github.com/flow-php/flow/blob/1.x/docs/components/libs/snappy.md)
+- ➡️ [Installation](https://github.com/flow-php/flow/blob/1.x/docs/installation.md)
 - 🛠️ [Contributing](https://github.com/flow-php/flow/blob/1.x/CONTRIBUTING.md)