localhots
/
musicbrainz
1
0
Fork 0
Code Releases Activity

Readme and travis

This commit is contained in:
Gregory Eremin 2012-10-17 18:48:41 +04:00
parent 7075744ad7
commit 517ff4bd76
2 changed files with 23 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.travis.yml
View File

@ -1,5 +1,4 @@
rvm: rvm:
- 1.9.2 - 1.9.2
- 1.9.3 - 1.9.3
- ruby-head
script: "bundle exec rspec" script: "bundle exec rspec"

43
README.md
View File

@ -1,8 +1,9 @@
## MusicBrainz Web Service wrapper [![Travis CI](https://secure.travis-ci.org/magnolia-fan/musicbrainz.png)](http://travis-ci.org/magnolia-fan/musicbrainz) ## MusicBrainz Web Service wrapper [![Travis CI](https://secure.travis-ci.org/magnolia-fan/musicbrainz.png)](http://travis-ci.org/magnolia-fan/musicbrainz)
## Ruby Version ### Ruby Version
*IMPORTANT!* **IMPORTANT!**
Ruby version 1.9+ required. No support for 1.8.7 anymore.
Ruby version 1.9+ required. No support for 1.8.7 anymore, update your application already!
### Installation ### Installation
``` ```
@ -13,6 +14,24 @@ or add this line to your Gemfile
gem "musicbrainz" gem "musicbrainz"
``` ```
### Configuration
```ruby
MusicBrainz.configure do |c|
# Application identity (required)
c.app_name = "My Music App"
c.app_version = "1.0"
c.contact = "support@mymusicapp.com"
# Cache config (optional)
c.cache_path = "/tmp/musicbrainz-cache"
c.perform_caching = true
# Querying config (optional)
c.query_interval = 1.2 # seconds
c.tries_limit = 2
end
```
### Usage ### Usage
```ruby ```ruby
require "musicbrainz" require "musicbrainz"
@ -26,22 +45,6 @@ require "musicbrainz"
# Use them like ActiveRecord models # Use them like ActiveRecord models
@empire_tracks = @kasabian.release_groups[8].releases.first.tracks @empire_tracks = @kasabian.release_groups[8].releases.first.tracks
# Configuring
MusicBrainz.configure do |c|
# Application identity (required)
c.app_name = "My Music App"
c.app_version = "1.0"
c.contact = "support@mymusicapp.com"
# Cache config (optional)
c.cache_path = "/tmp/musicbrainz-cache"
c.perform_caching = true
# Querying config (optional)
c.query_interval = 1.2 # seconds
c.tries_limit = 2
end
``` ```
### Api ### Api
@ -105,7 +108,7 @@ bundle exec irb -r musicbrainz
* 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 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 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project * Fork the project
* Start a feature/bugfix branch (*IMPORTANT*) * **Start a feature/bugfix branch (IMPORTANT)**
* Commit and push until you are happy with your contribution * 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. * 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. * 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.