Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Bodacious committed Jul 19, 2010
1 parent d3f2e71 commit 0e8c3bc
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.rdoc
Expand Up @@ -4,10 +4,10 @@ Here's an mp3_player plugin for Rails.
Check out http://handyrailstips.com/tips/7-playing-mp3-s-on-your-rails-site-with-mp3_player for more info Check out http://handyrailstips.com/tips/7-playing-mp3-s-on-your-rails-site-with-mp3_player for more info


To install: To install:
script/plugin install git://github.com/GavinM/mp3_player.git script/plugin install git://github.com/GavinM/mp3_player.git


To setup: To setup:
script/generate mp3_player [name of your mp3 directory] script/generate mp3_player [name of your mp3 directory]


This adds 'player.swf' to <em>public/</em> and creates a new folder for storing all of your audio files. This adds 'player.swf' to <em>public/</em> and creates a new folder for storing all of your audio files.


Expand All @@ -16,12 +16,12 @@ This adds 'player.swf' to <em>public/</em> and creates a new folder for storing
To play an mp3 file found in _public/mp3s/mysong.mp3_ simply add <%= mp3_player("mp3s/mysong.mp3") %> to your view. To play an mp3 file found in _public/mp3s/mysong.mp3_ simply add <%= mp3_player("mp3s/mysong.mp3") %> to your view.


If you're using paperclip: If you're using paperclip:
<%= mp3_player @my_model.mp3.url %>. <%= mp3_player @my_model.mp3.url %>.


Below is a list of the extra options you can specify: Below is a list of the extra options you can specify:
(All colors should be expressed as hexadecimal values minus the '#'. (All colors should be expressed as hexadecimal values minus the '#'.
eg. eg.
<%= mp3_player @my_model.mp3.url, :bg => "99FFFF") %> <%= mp3_player @my_model.mp3.url, :bg => "99FFFF") %>


[:width] width of the player when open in pixels, defaults to 290 [:width] width of the player when open in pixels, defaults to 290
[:class] class of the div wrapping the player, defaults to "mp3_player" [:class] class of the div wrapping the player, defaults to "mp3_player"
Expand Down

0 comments on commit 0e8c3bc

Please sign in to comment.