From bef3dad92922fbd261267221df349f3d2569b720 Mon Sep 17 00:00:00 2001
From: Thomas Albers <thomas@thomaslabs.org>
Date: Sun, 24 Jul 2022 12:21:29 +0200
Subject: Initial commit

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b010827
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# autotag
+
+Uses metadata from musicbrainz.org to fill song files with
+the tags of a given album.
+
+Thomas Albers Raviola <thomas@thomaslabs.org>
+
+## Usage
+
+`autotag [OPTION...] [DIRECTORY... | FILE...]`
+
+### Examples
+
+- `autotag --artist=<ARTIST> -A <ALBUM>` Assume that the directory working on has the same name as `<ALBUM>`
+
+
+### Options
+```
+    --artist=ARTIST        improve search results by providing an artist
+-A, --album=ALBUM          name of the album the files belong to
+-o, --order                ignore file names and assume that files are in order
+                           (useful for ripped CDs)
+-q, --quiet                do not output operations being done
+-h, --help                 show help options
+```
+
+## License
+
+GPL-3.0
+
-- 
cgit v1.2.3