aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
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
+