musicbrainz/README.rdoc

73 lines
2.0 KiB
Plaintext
Raw Normal View History

2011-07-18 07:02:37 +04:00
= MusicBrainz Web Service wrapper
2011-07-18 03:46:18 +04:00
2011-07-18 07:02:37 +04:00
=== Installation
2011-07-18 03:46:18 +04:00
2011-07-18 07:02:37 +04:00
gem install musicbrainz
=== Usage
require 'musicbrainz'
@kasabian = MusicBrainzArtist.find('69b39eab-6577-46a4-a9f5-817839092033')
@empire_tracks = @kasabian.release_groups[8].releases.first.tracks
=== Future
It should work all like ActiveRecord models.
=== Api
MusicBrainzArtist
MusicBrainzArtist.find(mbid)
MusicBrainzArtist.id
MusicBrainzArtist.type
MusicBrainzArtist.name
MusicBrainzArtist.country
MusicBrainzArtist.date_begin
MusicBrainzArtist.date_end
MusicBrainzArtist.release_groups
MusicBrainzReleaseGroup
MusicBrainzReleaseGroup.find(mbid)
MusicBrainzReleaseGroup.id
MusicBrainzReleaseGroup.type
MusicBrainzReleaseGroup.title
MusicBrainzReleaseGroup.first_release_date
MusicBrainzReleaseGroup.releases
MusicBrainzRelease
MusicBrainzRelease.find(mbid)
MusicBrainzRelease.id
MusicBrainzRelease.title
MusicBrainzRelease.status
MusicBrainzRelease.date
MusicBrainzRelease.country
MusicBrainzRelease.tracks
MusicBrainzTrack
MusicBrainzTrack.find(mbid)
MusicBrainzTrack.position
MusicBrainzTrack.recording_id
MusicBrainzTrack.title
MusicBrainzTrack.length
=== Contributing
2011-07-18 03:46:18 +04:00
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
2011-07-18 07:02:37 +04:00
=== Copyright
2011-07-18 03:46:18 +04:00
2011-07-18 07:02:37 +04:00
Copyright (c) 2011 Gregory Eremin. See LICENSE.txt for further details.