From 8c61d9664206d773275e157dddd5e837e5ed983d Mon Sep 17 00:00:00 2001
From: Evan Hsu <evan@liiingo.com>
Date: Thu, 4 Feb 2021 11:59:59 -0700
Subject: [PATCH] Update readme with workdir parameter

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

diff --git a/README.md b/README.md
index 74f8009..52e2eb5 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,19 @@ This Github action enables you to take the screenshots and videos generated by C
 
 **Required** Slack channels to upload to
 
+### `workdir`
+
+**Optional** The folder where Cypress stores screenshots and videos on the build machine.
+
+Default: `cypress`
+
+(this relative path resolves to `/home/runner/work/<REPO_NAME>/<REPO_NAME>/cypress`)
+
+If your project uses Cypress from the project root folder, the default value will work for you.
+But if your project uses Cypress in a subfolder (like most monorepos), you'll need to provide the relative path to that folder
+(i.e. `e2e/cypress`).
+(Don't include a trailing slash on your path!)
+
 ## Examples
 
 ### Upload results after every push