Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Aryan Mann authored Jan 14, 2017
1 parent 9ecebe4 commit 0739fd8
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Music Player
Are you tired of using Windows Explorer to search for and play music?
Would you like to be able to search for and play music within 4 seconds?
Music Player module is here to the rescue.
The MusicPlayer module for Project Butler is here to the rescue.

![alt text](http://aryanmann.com/wp-content/uploads/2017/01/AllSongs.png "All Songs")

## Installation
Download the latest build from GitHub and unzip the file into the Project Butler Modules folder. Yup, it's that easy.
Expand All @@ -10,9 +12,10 @@ Download the latest build from GitHub and unzip the file into the Project Butler

## Adding Songs
Create a folder called '***Songs***' under the Music Player module folder
or just run any command and Music Player will automatically create the folder for you.
or just run any command supported by MusicPlayer once and MusicPlayer will automatically create the folder for you.

You can either directly add songs to the folder or just add shortcuts to the songs.
You can either directly add songs to the folder or just add shortcuts to the songs and MusicPlayer will resolve those
shortcuts at runtime.

***Valid Extensions:*** ```MP3 M4A OGG WAV FLV FLAC INK (shortcut)```
## Commands
Expand All @@ -39,3 +42,11 @@ View all recognized songs and play one from them.
- ```all songs```
- ```list songs```
- ```list song```

## Seamless UI Integration
Upon receiving a play command, music player automatically plays the song if only one file is returned from
the search otherwise it will open a UI that is overlayed on top of the current window which allows you to choose.

Example:- If I search for **Decks Da**, it will automatically play it. If I search for **How**, it will return a list of songs.

![alt text](http://aryanmann.com/wp-content/uploads/2017/01/FilterSongsHow.png "Filtered Songs")

0 comments on commit 0739fd8

Please sign in to comment.