= MB-DiscID - Ruby bindings for MusicBrainz libdiscid

== About
MB-DiscID provides Ruby bindings for the MusicBrainz DiscID library libdiscid.
It allows you to calculate MusicBrainz DiscIDs from audio CDs which you can use
to find the release entry for your CD in the MusicBrainz database. 

== Requirements
* Ruby >= 1.8.6
* libdiscid >= 0.2.2 (>= 0.3.0 for MCN and ISRC support)

== Installation
Before installing rdiscid make sure you have libdiscid installed. See
http://musicbrainz.org/doc/libdiscid for more information on how to do this.

=== Installation with RubyGems
 gem install mb-discid
 
=== Installation on Windows operating systems.
For Windows a binary gem <tt>mb-discid-x.x.x-mswin32.gem</tt> is available. To
install it follow the instructions below:

1. Make sure you have at least Ruby 1.8.6 installed.
2. Install RubyGems, if you don't already have it.
3. Download <tt>libdiscid-0.1.1-win32bin.zip</tt> from
   http://musicbrainz.org/doc/libdiscid.
4. Copy the file <tt>discid.dll</tt> from <tt>libdiscid-0.1.1-win32bin.zip</tt>
   to your Ruby bin directory (normally <tt>C:\ruby\bin</tt>).
5. Run <tt>gem install mb-discid</tt> to install MB-DiscID.
6. To test the installation try to run <tt>examples/discid.rb</tt>.
 
=== Installing from source
 rake install

== Usage
See the documentation of MusicBrainz::DiscID or the example files in the
+examples+ directory for usage information.

== Contact
MB-DiscID is part of the RBrainz project which provides a library to query
the MusicBrainz XML web service. For more information about MB-DiscID or
RBrainz visit http://rbrainz.rubyforge.org.

If you have any questions or suggestions regarding MB-DiscID please write to
the rbrainz-user mailinglist[http://rubyforge.org/mail/?group_id=3677].
If you find bugs or if you have any feature requests please use the
RBrainz bug tracker[http://rubyforge.org/tracker/?group_id=3677]. 

== License
MB-DiscID is Copyright (c) 2007-2013 Philipp Wolfer.
It is free softare distributed under a BSD style license. See
LICENSE[link:files/LICENSE.html] for details.

$Id$