From 8f2c00c62099b7b8a5c59a2c7b2823d608fb409f Mon Sep 17 00:00:00 2001
From: tigattack <10629864+tigattack@users.noreply.github.com>
Date: Sat, 12 Oct 2024 14:48:25 +0100
Subject: [PATCH] docs: document `rclone_mkdir`

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

diff --git a/README.md b/README.md
index 0a00200..85f75f4 100644
--- a/README.md
+++ b/README.md
@@ -208,7 +208,9 @@ Note: This example assumes you have created the `rclone.service` systemd unit yo
 
 This variable allows for the configuration of rclone mounts within your infrastructure. `rclone_mounts` should be a YAML list of objects, each including keys for `name`, `remote_name`, `remote_path`, `local_path`, `auto_mount`, and `extra_args`. This setup enables precise control over multiple mount points, their remote sources, and whether they should be automatically mounted.
 
-If you use this variable, you must run this role as root using `become: true`.
+The role will attempt to create all defined `remote_path`'s by default. You can disable this by setting `rclone_mkdir` to `false`.
+
+If you use `rclone_mounts`, you must run this role as root using `become: true`.
 
 #### Detailed example for `rclone_mounts`