From 79e039b92ed474f911a2e95ed0b4fdce22b90b78 Mon Sep 17 00:00:00 2001
From: Janne Mareike Koschinski <janne@kuschku.de>
Date: Fri, 17 Dec 2021 18:29:26 +0100
Subject: [PATCH] feat: 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..37dcc47
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Audio-Renamer
+
+## Usage 
+
+```
+usage: audio-renamer.py [-h] [--dry-run] folders [folders ...]
+
+positional arguments:
+  folders     Folders to run the task on
+
+optional arguments:
+  -h, --help  show this help message and exit
+  --dry-run   Simulate renames
+```
+
+## Format
+
+The hardcoded default format in Amarok syntax is
+
+```
+%albumartist%/%album%{ (%originalyear%)}/{{%disc%-}%track%. }%title%.%extension%
+```
-- 
GitLab