diff --git a/README.md b/README.md index 8628743..ff6300e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -# **W**hat **Do** **I** **W**ant **T**o **L**isten **T**o +# `W`hat `Do` `I` `W`ant `T`o `L`isten `T`o + ## A simple, tag-based music library manager. This project is born out of a frustration I had managing my music library. @@ -6,16 +7,44 @@ I have found playlists, genres, and other ways of organizing my music too restrictive and cumbersome to keep up with. Here are the main features I want out of music player, in order of priority: +### Implemented + +* Song tagging. +* Playlists. +* Bookmarks (temporary song tag marking location in a playlist/album) +* Read meta-data from ID3. + +### TODO + * Web-based interface. * Mobile interface (could implement the Subsonic API on the back-end to be able to use pre-made mobile apps) -* Song tagging. -* Playlists. -* Read meta-data from ID3. * Transcoding on the fly. * Read songs from Amazon S3. * Stream from Amazon Cloudfront. -* Bookmarks (temporary song tag marking location in a playlist/album) -I have not found a music manager that gives me all of the above, so I'm going -to write my own. +I have not found a music manager that gives me all of the above, so I'm +writing my own. + +## Overview + +WDIWTLT is currently made up of two subprojects: + +* `core` +* `cli` + +### `core` + +`core` contains the data layer implementation, built with a lightweight ORM +layer over JDBC, and common functionality for managing a media library. + +### `cli` + +`cli` is a command-line interface built using the WDIWTLT core and VLC for +media playback. + +## Install + +The current version, 0.1.0, is an alpha version. + +*TODO: installation instructions.*