From 33575a87eb28009c010b4ed1cc1b8e15ba23b364 Mon Sep 17 00:00:00 2001
From: Daniel Siepmann <coding@daniel-siepmann.de>
Date: Wed, 30 Sep 2020 13:57:52 +0200
Subject: [PATCH] Add readme

---
 README.md  |  3 ---
 README.rst | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 41 insertions(+), 3 deletions(-)
 delete mode 100644 README.md
 create mode 100644 README.rst

diff --git a/README.md b/README.md
deleted file mode 100644
index e86a0ab..0000000
--- a/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# videocutting
-
-PHP Wrapper around ffmpeg to make cutting videos easier
\ No newline at end of file
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..3fdb247
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,41 @@
+============
+videocutting
+============
+
+A small PHP Wrapper around ffmpeg to make cutting videos easier.
+
+This project provides a single executable file that wraps a Symfony console command.
+The command itself accepts some arguments to cut out parts of a video file using ffmpeg.
+
+The resulting file will be moved to a dedicated folder structure.
+
+I'm currently developing this for myself in order to remove advertisements from recorded TV shows.
+I'm using https://www.youtv.de/ to record stuff.
+
+Drawbacks
+=========
+
+* Right now this script expects a specific file naming to extract information like season name.
+
+* Resulting file might be off between sound and video on some players (PS4 and my own TV).
+  Others work fine (Mozilla Firefox and VLC).
+
+Benefits
+========
+
+* Generates files very fast, by copying and not re encoding.
+
+Installation
+============
+
+Install requirements:
+
+* PHP 7.3 command line
+
+* ffmpeg
+
+#. Download / clone project.
+
+#. Run `composer install --no-dev -o`
+
+#. Execute executable `./cutvideo --help` to get instructions on how to use the script.