diff --git a/README.md b/README.md index 399855e..96e67bd 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,18 @@ Self hosted music listening statistics +### Dependencies +- PostgreSQL + +### Spotify Import Instructions (for testing and development): +- Navigate to the muzi project root dir +- Create a folder called "spotify-data" +- Inside the new "spotify-data" folder create a folder called "zip" +- Place all zip archives that you obtained from Spotify in this folder. +- Ensure the PostgreSQL server is running locally on port 5432. +- Run muzi.go +- All Spotify tracks that have > 20 second playtime will congregate into the muzi PostgreSQL database + ### plans: - Ability to import all listening statistics and scrobbles from lastfm, spotify, apple music - daily, weekly, monthly, yearly, lifetime presets for listening reports @@ -9,7 +21,6 @@ Self hosted music listening statistics - grid maker (3x3-10x10) - multi artist scrobbling - ability to change artist image -- optional AI powered suggestions/recommendation algorithm - webUI - ability to "sync" scrobbles (send from a device to the server) - live scrobbling to the server