From e7ad42e5ca74f941e7095adf78f0e8943f052540 Mon Sep 17 00:00:00 2001
From: tdeerenberg <113618658+tdeerenberg@users.noreply.github.com>
Date: Mon, 23 Jan 2023 21:12:56 +0100
Subject: [PATCH] Update README.md

---
 README.md | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 75 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b556c61..a2c1568 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,76 @@
+<img src="https://user-images.githubusercontent.com/113618658/214139255-c81222c9-48a2-46c9-a509-3e613d390d55.jpg" width="340" height="200" />
+
 # Musort
-Sort music files from their metadata
+
+A Python3 program that renames all selected music/audio files in a folder with a specified naming convention 
+
+## Features
+
+- Rename many audio files at once
+- Choose the naming convention (ex. track.title.flac or artist.track.year.mp3)
+- Give a separator for the naming of the file (ex. track.title.flac or track_title.flac)
+- Works on all systems that can run Python
+
+
+## Demo
+
+
+
+## Installation and Usage
+
+Clone the repository and run the Python program
+
+``` Bash
+git clone https://github.com/tdeerenberg/Musort.git
+cd Musort
+python3 musort.py
+```
+Alternatively, you could move `musort.py` into a directory in your `$PATH` and rename `musort.py` to `musort`. After that, the program can run like this:
+``` Bash
+musort -d music_directory -f track.title.year -s _
+```
+
+## Manual (options and arguments)
+```
+Musort © 2023 tdeerenberg (github.com/tdeerenberg)
+
+DESCRIPTION:
+A Python3 program that renames all selected music/audio files in a folder with a specified naming convention 
+
+USAGE:
+musort [OPTION] [ARGUMENT]...
+
+OPTIONS:
+-h, --help           Show the help menu
+-d, --dir            Set the directory with the music files in it
+-f, --format         Set the naming convention (ex. track.artist.year) Full list of option below.
+-s, --separator      Set the separator for the filename (ex. '-s .' -> 01.track.flac and '-s -' -> 01-track.mp3)
+
+FORMAT OPTIONS:
+album         album as string
+albumartist   album artist as string
+artist        artist name as string
+audio_offset  number of bytes before audio data begins
+bitdepth      bit depth for lossless audio
+bitrate       bitrate in kBits/s
+comment       file comment as string
+composer      composer as string 
+disc          disc number
+disc_total    the total number of discs
+duration      duration of the song in seconds
+filesize      file size in bytes
+genre         genre as string
+samplerate    samples per second
+title         title of the song
+track         track number as string
+track_total   total number of tracks as string
+year          year or date as string
+```
+## Authors
+
+- [@tdeerenberg](https://www.github.com/tdeerenberg)
+
+## License
+
+[GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/)
+Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights.