From 6a4e6f58cb4a34acc862857cf27549339cecf226 Mon Sep 17 00:00:00 2001
From: Riccardo Rigutini <47950599+richardrigutins@users.noreply.github.com>
Date: Fri, 10 Nov 2023 17:52:00 +0000
Subject: [PATCH] Add documentation for max-parallelism option

---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index f0203e0..e97fbf7 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,9 @@ It can be useful for automating repetitive tasks such as updating version number
 - `exclude`:
 (Optional) The files to be excluded from the search. It can be the path to a file or a glob pattern matching one or more files (e.g. `**/*.md`). Defaults to an empty string.
 
+- `max-parallelism`:
+(Optional) The maximum number of files that will be processed in parallel. This can be used to control the performance impact of the operation on the system. It should be a positive integer. Defaults to `10`.
+
 ## Example usage
 
 ```yaml
@@ -41,6 +44,7 @@ It can be useful for automating repetitive tasks such as updating version number
     replacement-text: 'world'
     exclude: 'node_modules/**'
     encoding: 'utf8'
+    max-parallelism: 10
 
 # Replace all the occurrences of '{0}' with '42' in the README.md file
 - name: Replace single file