README.md in mpg321-0.0.2 vs README.md in mpg321-0.0.3

- old
+ new

@@ -1,11 +1,17 @@ Mpg321 =========== +[![Build Status](https://travis-ci.org/RichardVickerstaff/mpg321.svg)](https://travis-ci.org/RichardVickerstaff/mpg321) +[![Gem Version](https://badge.fury.io/rb/mpg321.svg)](http://badge.fury.io/rb/mpg321) + A simple ruby wrapper around mpg321 ----------------------------------- +Mpg321 is a wrapper for the [mpg321][mpg321] library in "Remote control" mode, which +allows to you play, pause, stop and control the volume of mp3 files from Ruby. + Installation ------------ Either: - Add `gem "mpg321"` to your Gemfile and run bundle install. @@ -13,12 +19,28 @@ - Run `gem install mpg321` Usage ----- +Here's how you can easily play an mp3: +```ruby +require 'mpg321' + +Mpg321.new.play('/some_path/song.mp3') +``` + +Play mutiple mp3 files: + +```ruby +require 'mpg321' + +Mpg321.new.play(['/some_path/song1.mp3', '/some_path/song2.mp3']) +``` Contributing ------------ 1. Make a fork 2. Make your changes 3. Push your changes to your fork 4. Create a Pull Request + +[mpg321]: http://linux.die.net/man/1/mpg321