From 3ec565afd321e304aed681c4e4d208e6aff7ee3d Mon Sep 17 00:00:00 2001
From: jigglycrumb <1476865+jigglycrumb@users.noreply.github.com>
Date: Wed, 1 Nov 2023 21:43:11 +0100
Subject: [PATCH] re-add README

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..64640fd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# TvTool
+
+A web based tool to format file names for TV show episodes.
+
+If you are using a PVR to record series, this is the tool for you.
+
+There is no need to install anything, you can use it directly at [http://jigglycrumb.github.io/tvtool](http://jigglycrumb.github.io/tvtool)
+
+### Setup
+
+- Clone repository
+- Run `npm install`
+
+### Development
+
+- Run dev server: `npm start`
+- Build: `npm run build`
+
+### Deployment
+
+Runs on Github pages, from the `docs` folder.
+Do a manual build and commit it to deploy.