From dd4b7460c0f2c38467dc5972563f9d0961c385f4 Mon Sep 17 00:00:00 2001 From: Jonathan Cremin Date: Thu, 4 Dec 2014 23:17:54 +0000 Subject: [PATCH] Udpate todo --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7e9b188..649dc15 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,24 @@ #match.audio [![Circle CI](https://circleci.com/gh/kudos/match.audio.svg?style=svg)](https://circleci.com/gh/kudos/match.audio) -Make sharing music from subscription services better. Give us one link (Rdio, Spotify or Google Music) and we'll match it with other services and give you back a link with all of them. +Make sharing from music services better. We match links from Rdio, Spotify, Deezer, Beats Music, Google Music and iTunes and give you back a link with all of them. -You'll need to have Rdio API keys (`RDIO_API_KEY` and `RDIO_API_SHARED`) and Google credentials (`GOOGLE_EMAIL` and `GOOGLE_PASSWORD`) and provide them via environment variables. Google doesn't provide an API for Play Music, hence this terrible hackery. +Some of the services require keys/credentials be passed via environment variables: + +Rdio: `RDIO_API_KEY` and `RDIO_API_SHARED` +Beats Music: `BEATS_KEY` and `BEATS_SECRET` +Google Play Music: `GOOGLE_EMAIL` and `GOOGLE_PASSWORD` + +Google doesn't provide an API for Play Music, hence this `GOOGLE_PASSWORD` awfulness. + +If you don't provide credentials, it will simply disable support for that service. Spotify, Deezer and iTunes don't need any auth. To get started, first `npm install` and then run the app with `npm start` or tests with `npm test`. -This is in super early development, has no design and only supports albums right now. +This is in super early development and is incapable of handling getting dugg, never mind hacker news. On the immediate todo list: * Use album release year for additional sanity check on matches +* Maybe drop everything from the first special character in album names to improve matches **after** failing to get a good match * Handle expected and unexpected errors better than the current crash-fest -* Use promises for service searches and do them simultaneously +* Add some kind of persistence or caching so it could take a pummeling and not get me banned from the various services