aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 492d21a..4a08864 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,14 @@
-# filmstripper
+# Filmstripper
+A tool for fusing multiple images together into a single filmstrip.
+
+## Usage
+
+Filmstripper takes a folder as input and a file-path as output. It can generate both vertical and horizontal filmstrips, the choice is made by either writing `v` for vertical, or `h` for horizontal. Vertical is the default, if nothing else is chosen.
+
+```
+python3 filmstripper.py /input/directory/ /output/file.png [v/h]
+```
+
+## Examples
+
+`N/A`