Permalink
Browse files

updating documentation

  • Loading branch information...
1 parent 560ebb1 commit 90be4a3feb1b6033b82d15fecf2a076c2684da7b @TwP committed Feb 5, 2011
Showing with 24 additions and 10 deletions.
  1. +23 −8 README.txt → README.md
  2. +1 −2 Rakefile
@@ -1,20 +1,35 @@
-bones-rspec
- by Tim Pease
- http://rubygems.org/gems/bones-rspec
+# bones-rspec
-== DESCRIPTION:
+A plugin for [Mr Bones](http://rugyems.org/gems/bones) that incorporates rake
+tasks for running RSpec style tests.
+
+## DESCRIPTION
The rspec package for Mr Bones provides tasks to incorporate rspec tests into
bones based projects. It also works in tandem with the bones-rcov plugin to
run code coverage over your specs.
-== INSTALL:
+This plugin is compatible with both RSpec version 1 and RSpec version 2. If
+you have both RSpec versions installed this plugin will favor the newer
+version of RSpec. To force use of the older RSpec version, use the **gem**
+command in your Rakefile to load the appropriate version.
+
+ gem 'rspec', '~> 1.3.0'
+
+ Bones {
+ name 'my-awesome-gem'
+ ...
+ }
+
+The gem command must appear before the Bones configuration block.
+
+## INSTALL
- gem install bones-rspec
+ gem install bones-rspec
-== LICENSE:
+#### LICENSE
-(The MIT License)
+*The MIT License*
Copyright (c) 2010
View
@@ -10,10 +10,9 @@ Bones {
authors 'Tim Pease'
email 'tim.pease@gmail.com'
url 'http://github.com/TwP/bones-rspec'
- ignore_file '.gitignore'
depend_on 'bones'
- depend_on 'rspec', '~> 1'
+ depend_on 'rspec'
use_gmail
}

0 comments on commit 90be4a3

Please sign in to comment.