diff --git a/README.md b/README.md index ef03849..12473c4 100644 --- a/README.md +++ b/README.md @@ -17,13 +17,15 @@ A summary of their usage follows. You can also execute them with `--help` for ad To embed an image into an mp3 file, use `id3-image-embed`: ``` -id3-image-embed +id3-image-embed [image-file.jpg] ``` The image doesn't *have* to be a JPEG, anything that the [image](https://github.com/PistonDevelopers/image) library accepts will work. It will, however, be embedded as a JPEG for no particular reason other than seeming like a sensible default choice. The ID3 tags will be stored as ID3v2.3, and written in-place in the music file. +The image filepath is optional -- if omitted, the program is going to look for an image with the same name, but with a "jpg" extension. This is a bit specific, but fits with the default extraction filename, making it easy to extract → edit → embed. + ## Extracting In order to extract an embedded image file from an mp3, use `id3-image-extract`: @@ -105,5 +107,5 @@ Elevator Music Attempt 1 by Christian Bakker: http://www.jamendo.com/en/list/a98 - Don't silently overwrite images when extracting - Allow different output formats - Allow different ID3 versions -- Allow embedding/extracting multiple images (currently, on the first one is extracted) +- Allow embedding/extracting multiple images (currently, only the first one is extracted) - Replace structopt + clap with a simpler CLI solution -- a lot of dependencies for a simple project