Initial commit.
[ruby-discid.git] / README
1 = ruby-discid
2
3 ruby-discid is a set of Ruby bindings to MusicBrainz' libdiscid.
4
5 ruby-discid is maintained by:
6
7 :include: AUTHORS
8
9 == License
10
11 ruby-discid is available under an MIT-style license.
12
13 :include: COPYING
14
15 == Download
16
17 The latest version of ruby-discid can be found at
18 http://code-monkey.de/pages/ruby-discid
19
20 Online documentation is available at
21 http://docs.code-monkey.de/ruby-discid
22
23 == Dependencies
24
25 ruby-discid depends on Rake[http://rake.rubyforge.org] 0.5.0
26 or greater and libdiscid[http://musicbrainz.org/doc/libdiscid].
27
28 == Installation
29
30 Run "rake install" to install ruby-discid.
31
32 == Usage
33
34 Have a look at this example:
35
36   require "discid"
37
38   discid = DiscID::DiscID.read("/dev/hdc")
39
40   puts discid.id
41   puts discid.submission_url
42
43 That's basically all you need.