README.md in rspec-scaffold-0.1.0 vs README.md in rspec-scaffold-0.2.0
- old
+ new
@@ -1,23 +1,30 @@
-# RSpec::Scaffold
+# RSpec Scaffolding [](https://travis-ci.org/ridiculous/rspec-scaffold)
-Generates RSpec scaffolding for existing code. Takes either a file or a directory.
+Generates RSpec scaffolding for existing code. Helps you write tests by showing you what you should be testing,
+which are conditions and changes to state (at a minimum).
## Installation
+Requires Ruby >= 1.9.3
+
```ruby
gem 'rspec-scaffold'
```
## Usage
+Takes either a file or a directory.
+
```bash
rake rspec:scaffold[lib]
```
## Example
+Given:
+
```ruby
# app/models/ability.rb
class Ability
include CanCan::Ability
@@ -30,9 +37,13 @@
u.id == user.id
end
end
end
end
+```
+
+```bash
+rake rspec:scaffold[app/models/ability.rb]
```
Outputs:
```ruby