Skip to content

Commit

Permalink
added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jpablobr committed Feb 7, 2012
1 parent e2a1989 commit 0e03542
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Playr - Ruby Interface for the Music Player Daemon 2

# Description

Playr is a command-line based MPD client that tries to provide extra
features on top of the mpc(1) client.

Disclaimer: not nearly done!

# Usage

The following command:

$ playr -s

will spawn the interactive playr shell. Where the:

> help

command will show the available options for interacting with your
music.

# TODO:
* a lot! :D

2 changes: 1 addition & 1 deletion playr.rb
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ def song_name song; song.gsub(/(.*\/)|(\..*$)/,'') end
end

opts = OptionParser.new do |o|
o.banner = "Usage: mpd [OPTION] [<args>]"
o.banner = "Usage: playr [OPTION] [<args>]"
o.separator ""
o.on("-h", "--help", "Print this help.") {
return $stderr.puts(opts)
Expand Down

0 comments on commit 0e03542

Please sign in to comment.