Update readme with RDoc, Travis, Coveralls, Gemnasium and CodeClimate

revdotcom · Sep 26, 2013 · 680333b · 680333b
1 parent 27a0e0e
commit 680333b
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 2 deletions.
diff --git a/.coveralls.yml b/.coveralls.yml
@@ -0,0 +1,2 @@
+service_name: travis-pro
+repo_token: sxagPJJLWdT4EPbWoaCHvarBQMCxbfCym
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,11 @@
+language: ruby
+before_install: gem install bundler
+bundler_args: --without guard metrics
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+branches:
+  only: master
+notifications:
+  email: api@rev.com
diff --git a/Gemfile b/Gemfile
@@ -1,3 +1,4 @@
 source "https://rubygems.org"
 
 gemspec
+gem 'coveralls', require: false
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -9,17 +9,34 @@ GEM
   specs:
     addressable (2.3.5)
     ansi (1.4.3)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
     crack (0.4.1)
       safe_yaml (~> 0.9.0)
     httparty (0.11.0)
       multi_json (~> 1.0)
       multi_xml (>= 0.5.2)
+    mime-types (1.25)
     multi_json (1.8.0)
     multi_xml (0.5.5)
     rake (10.1.0)
     redcarpet (3.0.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
     rubygems-tasks (0.2.4)
     safe_yaml (0.9.5)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tins (0.11.0)
     turn (0.9.6)
       ansi
     vcr (2.5.0)
@@ -32,6 +49,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  coveralls
   rake (>= 10.1.0)
   redcarpet
   rev-api!

diff --git a/README.md b/README.md
@@ -1,3 +1,11 @@
+[![Gem Version](https://badge.fury.io/rb/rev-api.png)](http://badge.fury.io/rb/rev-api)
+[![Build Status](https://secure.travis-ci.org/revdotcom/rev-ruby-sdk.png?branch=master)](https://secure.travis-ci.org/revdotcom/rev-ruby-sdk)
+[![Dependency Status](https://gemnasium.com/revdotcom/rev-ruby-sdk.png?travis)](https://gemnasium.com/revdotcom/rev-ruby-sdk)
+[![Code Climate](https://codeclimate.com/github/revdotcom/rev-ruby-sdk.png)](https://codeclimate.com/github/revdotcom/rev-ruby-sdk)
+[![Coverage Status](https://coveralls.io/repos/revdotcom/rev-ruby-sdk/badge.png)](https://coveralls.io/r/revdotcom/rev-ruby-sdk)
+
+[Reference](http://www.rev.com/api/docs) | [RDocs](http://rubydoc.info/github/revdotcom/rev-ruby-sdk/master/frames)
+
 rev-ruby-sdk
 ------------
 
@@ -96,7 +104,7 @@ Refer to `cli.rb` in the `examples` directory for a full example illustrating pl
 
 ### Documentation
 
-YARD documentation can be generated by running `rake yard` command, and will be placed in the `doc` directory.
+[YARD documentation](http://rubydoc.info/github/revdotcom/rev-ruby-sdk/master/frames) can be generated locally by running `rake yard` command, and will be placed in the `doc` directory.
 
 You can find API documentation at <http://www.rev.com/api/docs>.
 

diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 require_relative '../lib/rev-api'
 
 #dependencies
@@ -7,7 +10,7 @@
 require 'turn'
 
 module MiniTest
-  class Spec 
+  class Spec
     class << self
       def xit(desc='anonymous')
         it(name) { skip 'DISABLED' }