diff --git a/plugins/ChangeFileMonitor/README.md b/plugins/ChangeFileMonitor/README.md index ca09e59..30cd241 100644 --- a/plugins/ChangeFileMonitor/README.md +++ b/plugins/ChangeFileMonitor/README.md @@ -1,12 +1,20 @@ # ChangeFileMonitor: Ver 0.1.0 (By David Maisonave) ChangeFileMonitor is a [Stash](https://github.com/stashapp/stash) plugin which updates Stash if any changes occurs in the Stash library paths. -### Using ChangeFileMonitor +### Using ChangeFileMonitor as a plugin - To start monitoring file changes, go to **Stash->Settings->Task->[Plugin Tasks]->ChangeFileMonitor**, and click on the [Start Library Monitor] button. - ![ChangeFileMonitor_Task](https://github.com/user-attachments/assets/f275a70f-8e86-42a4-b2c1-98b3f4935334) - To stop this task, go to **Stash->Settings->Task->[Task Queue]**, and click on the **[x]**. - ![Kill_ChangeFileMonitor_Task](https://github.com/user-attachments/assets/a3f4abca-f3a2-49fa-9db5-e0c733e0aeb1) +### Using ChangeFileMonitor as a script +**ChangeFileMonitor** can be called as a standalone script. +- To start monitoring call the script and pass any argument. + - python changefilemonitor.py **foofoo** +- To stop **ChangeFileMonitor**, pass argument **stop**. + - python changefilemonitor.py **stop** + - After running above command line, **ChangeFileMonitor** will stop after the next file change occurs. + - The stop command works to stop the standalone job and the Stash plugin task job. ### Requirements `pip install stashapp-tools`