Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Dan Kantor committed Aug 31, 2012
1 parent 8178ede commit 0cf6e6c
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
@@ -1,6 +1,13 @@
# Playqueue

Don't ever want to rewrite this again.
This is a wrapper of sorts around an Audio object to provide extra funcitonality
that is always needed when writing a music player. Given a list of songs, it will
provide functionality such as
* skipping to the next song once the current one has finished.
* triggering an event when the song is halfway finished (useful for scrobbling)
* storing the list in localStoarge
* moving songs from one spot to another
* and much more


## Install
Expand All @@ -14,4 +21,8 @@ Don't ever want to rewrite this again.


var PlayQueue = require('playqueue'),
pq = new PlayQueue;
pq = new PlayQueue({'audio': new Audio()});

pq.add(['url', 'url2']);
pq.play(0);
pq.addEventListener('songHalf', function(e){...})

0 comments on commit 0cf6e6c

Please sign in to comment.