From d325172703e9fd4d250f51b66823299c15c08c06 Mon Sep 17 00:00:00 2001
From: David Maisonave <47364845+David-Maisonave@users.noreply.github.com>
Date: Mon, 22 Jul 2024 04:26:38 -0400
Subject: [PATCH] Update README.md

---
 plugins/RenameFile/README.md | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/plugins/RenameFile/README.md b/plugins/RenameFile/README.md
index 34d05c8..356e3e5 100644
--- a/plugins/RenameFile/README.md
+++ b/plugins/RenameFile/README.md
@@ -2,9 +2,10 @@
 RenameFile is a [Stash](https://github.com/stashapp/stash) plugin which performs the following two main task.
 - **Rename Scene File Name** (On-The-Fly)
 - **Append tag names** to file name
+- **Append Performer names** to file name
 
 It allows users to rename the video (scene) file name by editing the [Title] field located in the scene [Edit] tab.
-In addition, the plugin also appends tags to the file name if the tag does not already exist in the name.
+In addition, the plugin optionally also appends tags and performers to the file name if the name does not already exist in the original file name.
 
 Note: This script is **largely** based on the [Renamer](https://github.com/Serechops/Serechops-Stash/tree/main/plugins/Renamer) script.
 
@@ -13,13 +14,14 @@ Note: This script is **largely** based on the [Renamer](https://github.com/Serec
   - Note: Do **NOT** include the file folder name and do **NOT** include file extension. 
 - After populating the Title field, click the save button.
 - After a few seconds, the file will get renamed and the screen will get updated with the new file name.
-- By default tag names are appended to the file name only if the tags do not exist in the original name.
-  - The [Tag Append] feature can be disabled by adding "tags" to the **exclude_keys** field in **renamefile_settings.py** file.
+- The append tags and perfomers option is disable by default. To enable these options go to the Settings->Plugins->Plugins->[RenameFile] field options, and enable the associated field.
+- When [Append Tags] is enabled, by default tag names are appended to the file name only if the tags do not exist in the original name. Same applies to [Append Performers] option.
 - Since this plugin is largely based on the [Renamer](https://github.com/Serechops/Serechops-Stash/tree/main/plugins/Renamer) plugin, it inherited some of its features, like being able to include any of the following fields when auto-renaming is executed:
   - studio, performers, date, height, video_codec, frame_rate
-  - To add these fields removed the desired field(s) from **exclude_keys** in renamefile_settings.py.
-  - To change the order, modify the **key_order** field.
-  - There is a **dry_run** option in the renamefile_settings.py, and I highly recommend enabling this option before making changes to renamefile_settings.py. The renamefile.log can be reviewed to verify that the rename action will occur as expected.
+  - To add these fields see the [Key Fields] option in Settings->Plugins->Plugins->[RenameFile].
+  - The [Key Fields] can also be used to change the order for the file name format.
+- There are many options in Plugins->[RenameFile] UI, and all the options have detailed descriptions. Please advise us if any of the options need further clarification, and provide example details.
+- There are additional options in renamefile_settings.py, but these options should only be changed by advanced users, and any changes should be tested first with the [Dry-Run] option enabled.
 
 **Note:** On Windows 10/11, the file can not be renamed while it's playing. It will result in following error:
 `