re-add README

jigglycrumb · Nov 1, 2023 · ce38b5e · ce38b5e
1 parent 4939db7
commit ce38b5e
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md 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.