From a0c93bd764a3c25e6999397e9f5f119c1b124e38 Mon Sep 17 00:00:00 2001
From: Sridhar Ratnakumar <3998+srid@users.noreply.github.com>
Date: Tue, 9 May 2023 14:54:44 -0400
Subject: [PATCH] readme: mention `cdToProjectRoot`

Resolves #34
---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 282570f..d94a9f9 100644
--- a/README.md
+++ b/README.md
@@ -36,7 +36,7 @@ Available commands:
 
 Once you are in the dev shell, you can run any of these scripts prefixed with the wrapper name `,`.  For example, `, fmt` to format the Nix files.
 
-The scripts will be run *always* from the project root directory[^flake-root] regardless of the current working directory.
+Note: The scripts will *always* be run from the project root directory[^flake-root] regardless of the current working directory. You can disable this behaviour by setting the `cdToProjectRoot` option to `false`.
 
 [^flake-root]: "Project root directory" is determined by traversing the directory up until we find the unique file that exists only at the root. This unique file is `flake.nix` by default, which can be overridden using the [flake-root](https://github.com/srid/flake-root) module that this module mandatorily requires; i.e.; `flake-root.projectRootFile = "stack.yaml";`