Updated README to include Wish List

davewalker5 · Nov 10, 2023 · 4ad0d63 · 4ad0d63
1 parent cfcab03
commit 4ad0d63
Show file tree

Hide file tree

Showing 12 changed files with 53 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -26,7 +26,8 @@
 
 - The Music Catalogue repository is intended to provide a catalogue for a private music collection
 - It supports the following functions:
-  - Music catalogue collection browser
+  - Music catalogue collection browser (artists, albums and tracks)
+  - A "wish list" of albums with the ability to move albums between the main catalogue and the wish list at will
   - Album search
   - External API integration for looking up new albums
   - Data import from CSV format files
@@ -68,14 +69,22 @@
 
 - The following command line arguments are supported:
 
-| Option   | Short Name | Required Values          | Comments                                    |
-| -------- | ---------- | ------------------------ | ------------------------------------------- |
-| --lookup | -l         | Artist name, album title | Performs an album lookup                    |
-| --import | -i         | CSV file path            | Import data from the specified CSV file     |
-| --export | -e         | File path                | Export the collection to the specified file |
+| Option   | Short Name | Required Values                  | Comments                                    |
+| -------- | ---------- | -------------------------------- | ------------------------------------------- |
+| --lookup | -l         | Artist name, album title, target | Performs an album lookup                    |
+| --import | -i         | CSV file path                    | Import data from the specified CSV file     |
+| --export | -e         | File path                        | Export the collection to the specified file |
+
+- For album lookups
+  - It is recommended that the artist name and album title are both double-quoted
+  - This is mandatory if either contains spaces
+  - The target determines whether the album is tagged as being in the wish list or the main catalogue:
+
+| Value     | Target                                 |
+| --------- | -------------------------------------- |
+| wishlist  | Store new albums in the wish list      |
+| catalogue | Store new albums in the main catalogue |
 
-- For album lookups, it is recommended that the artist name and album title are both double-quoted
-- This is mandatory if either contains spaces
 - For data exports, the exported format is based on the file extension for the supplied file path:
 
 | Extension | Exported format |
@@ -90,14 +99,19 @@
 - The following is an example, illustrating the format for the headers and for the rows containing data:
 
 ```
-Artist,Album,Genre,Released,Cover Url,Track Number,Track,Duration
-Duke Ellington,Ellington Indigoes,Jazz,1958,,1,Solitude,04:43
+Artist,Album,Genre,Released,Cover Url,Track Number,Track,Duration,Wish List
+Duke Ellington,Ellington Indigoes,Jazz,1958,,1,Solitude,04:43,False
 ```
 
+- Exports include all albums in both the main catalogue and the wish list
+
 ### Example - Album Lookup
 
+- The following command will look-up the album "Blue Train" by John Coltrane
+- In this example, if the album isn't stored locally and is looked up using the external APIs (see below) the results will be stored in the main cataloge
+
 ```bash
-MusicCatalogue.LookupTool --lookup "John Coltrane" "Blue Train"
+MusicCatalogue.LookupTool --lookup "John Coltrane" "Blue Train" catalogue
 ```
 
 - The output lists the album details and the number, title and duration of each track:
@@ -138,6 +152,8 @@ MusicCatalogue.LookupTool --lookup "John Coltrane" "Blue Train"
 
 ### Browsing the Catalogue
 
+#### Main Catalogue
+
 - After logging in, the "Artists" page is displayed, listing the artists currently in the database
 - This acts as the home page for the site and clicking on the "Artists" menu item or the site logo navigates back to it
 
@@ -150,19 +166,32 @@ MusicCatalogue.LookupTool --lookup "John Coltrane" "Blue Train"
 
 - As the mouse pointer is moved up and down the table, the current row is highlighted
 - Clicking on the trash icon prompts for confirmation and, if confirmed, deletes the album shown in that row along with the associated tracks
+- Clicking on the "heart" icon moves the album from the main catalogue to the wish list then refreshes the album list
 - Clicking anywhere else on a row opens the track list for the album shown in that row:
 
 <img src="diagrams/track-list.png" alt="Track List" width="600">
 
 - Clicking on the artist name in any row in the track list or clicking on the "Back" button returns to the album list for that artist
 
+#### The Wish List
+
+- To view the wish list, click on the "Wish List" menu item
+- A page identical in layout to the "Artists" page is displayed, but with a title indicating that it is the wish list
+- The page operates in an identical manner to the "Artists" page and clicking on a row in the table navigates to the wish list for that artist:
+
+<img src="diagrams/wish-list-album-list.png" alt="Wish List Album List" width="600">
+
+- Clicking on a row drills into the album content, as per the "Artists" page
+- Clicking on the trash icon prompts for confirmation and, if confirmed, deletes the album shown in that row along with the associated tracks
+- Clicking on the vinyl record icon moves the album from the wish list to the main catalogue then refreshes the album list
+
 ### Album Lookup
 
 - To search for an album, click on the "Search" menu bar item:
 
 <img src="diagrams/album-search.png" alt="Album Search" width="600">
 
-- Enter the artist name and album title then click on "Lookup" to search for the album
+- Enter the artist name and album title and select the target directory (wish list or main catalogue) then click on "Lookup" to search for the album
 - If the album is found, the track list for the album is displayed
 - The album lookup facility uses the algorithm described under "Album Lookup", below
 - Consequently, searching for an album that's not currently in the catalogue will add it to the local database

diff --git a/diagrams/album-list.png b/diagrams/album-list.png
diff --git a/diagrams/album-search.png b/diagrams/album-search.png
diff --git a/diagrams/artist-list.png b/diagrams/artist-list.png
diff --git a/diagrams/database-schema.png b/diagrams/database-schema.png
diff --git a/diagrams/reports-job-status.png b/diagrams/reports-job-status.png
diff --git a/diagrams/track-list.png b/diagrams/track-list.png
diff --git a/diagrams/wish-list-album-list.png b/diagrams/wish-list-album-list.png
diff --git a/wireframes/Example Data.xlsx b/wireframes/Example Data.xlsx
diff --git a/wireframes/Music Catalogue - v9.00.pdf b/wireframes/Music Catalogue - v9.00.pdf
diff --git a/wireframes/Music Catalogue.bmpr b/wireframes/Music Catalogue.bmpr
diff --git a/wireframes/Wish List Track List.csv b/wireframes/Wish List Track List.csv
@@ -0,0 +1,12 @@
+Live In Paris,[Diana Krall],1,I Love Being Here With You,05:12
+Live In Paris,[Diana Krall],2,Let's Fall In Love,04:34
+Live In Paris,[Diana Krall],3,'Deed I Do,05:17
+Live In Paris,[Diana Krall],4,The Look Of Love,05:00
+Live In Paris,[Diana Krall],5,East Of The Sun (And West Of The Moon),05:58
+Live In Paris,[Diana Krall],6,I've Got You Under My Skin,07:24
+Live In Paris,[Diana Krall],7,Devil May Care,06:52
+Live In Paris,[Diana Krall],8,Maybe You'll Be There,05:47
+Live In Paris,[Diana Krall],9,'S Wonderful,05:59
+Live In Paris,[Diana Krall],10,Fly Me To The Moon,06:05
+Live In Paris,[Diana Krall],11,A Case Of You,07:04
+Live In Paris,[Diana Krall],12,Just The Way You Are,05:00