From 1d43e8692fff012adcc3ca3494c5eff5a62dc1b4 Mon Sep 17 00:00:00 2001
From: HaveAGitGat <43864057+HaveAGitGat@users.noreply.github.com>
Date: Sun, 27 Aug 2023 10:12:50 +0100
Subject: [PATCH] Steps to write a Tdarr Flow plugin

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

diff --git a/README.md b/README.md
index 8621dcb..d347c52 100644
--- a/README.md
+++ b/README.md
@@ -28,3 +28,15 @@ Check plugins using some extra custom rules:
 Run tests:
 
 `npm run test`
+
+
+# Steps to write a Tdarr Flow plugin:
+
+1. Clone this repo
+2. Set env variable `pluginsDir` to the location of the plugins repo and run Tdarr Server and Node. E.g. `export pluginsDir=C:/Tdarr_Plugins`
+3. Browse the typescript plugins here https://github.com/HaveAGitGat/Tdarr_Plugins/tree/master/FlowPluginsTs/CommunityFlowPlugins and make edits locally or create a new one locally: 
+4. Make sure typescript is intalled with `npm i -g typescript` then run `tsc` to compile the changes.
+5. Refresh the browser and Tdarr will pick up the changes
+
+
+