Permalink
Browse files

Update documentation.

  • Loading branch information...
1 parent b3a42c2 commit 8b74578773194e631cbea192af618d38f8a934df @tylerhunt committed May 3, 2012
Showing with 46 additions and 37 deletions.
  1. +1 −1 LICENSE
  2. +45 −36 README.markdown
View
2 LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2010-2011 Tyler Hunt
+Copyright (c) 2010-2012 Tyler Hunt
MIT License
View
81 README.markdown
@@ -12,7 +12,7 @@ A collection of RSpec 2 matchers to simplify your web app specs.
The goal of this project is to provide a modern replacement to the now
unmaintained Remarkable project. Remarkable was a great asset when Rails 2.3
-was current, but now that Rails 3.0 has become mainstream, a gap has been left
+was current, but now that Rails 3 has become mainstream, a gap has been left
by still unreleased Remarkable 4.0.
In looking at the code for Remarkable to determine the feasibility of continuing
@@ -22,58 +22,67 @@ Remockable was born. It's an attempt to start with a clean slate but maintain
the original goal of Remarkable in spirit.
-## Active Model Matchers
+## Installation
-The following Active Model matchers are supported:
+Add this line to your application's Gemfile:
- * allow_mass_assignment_of
- * validate_acceptance_of
- * validate_confirmation_of
- * validate_exclusion_of
- * validate_format_of
- * validate_inclusion_of
- * validate_length_of
- * validate_numericality_of
- * validate_presence_of
+``` ruby
+gem 'remockable'
+```
+And then execute:
-## Active Record Matchers
+ $ bundle
-The following Active Record matchers are supported:
+Or install it yourself as:
- * have_column
- * have_index
- * have_scope
- * have_default_scope
- * belong_to
- * have_one
- * have_many
- * have_and_belong_to_many
- * validate_associated
- * validate_uniqueness_of
+ $ gem install remockable
-## Installation
+## Usage
-Add the `remockable` gem to your `Gemfile`:
+Remockable provides matchers for use with Active Model and Active Record
+classes.
- gem 'remockable'
+### Active Model Matchers
-Then run `bundle install` to install the gem.
+The following Active Model matchers are supported:
+
+ * `allow_mass_assignment_of`
+ * `validate_acceptance_of`
+ * `validate_confirmation_of`
+ * `validate_exclusion_of`
+ * `validate_format_of`
+ * `validate_inclusion_of`
+ * `validate_length_of`
+ * `validate_numericality_of`
+ * `validate_presence_of`
-You'll also want to make sure the library is required by RSpec, so add the
-following to your `spec_helper.rb` or someone else where it will get loaded
-when your specs do:
+### Active Record Matchers
+
+The following Active Record matchers are supported:
- require 'remockable'
+ * `have_column`
+ * `have_index`
+ * `have_scope`
+ * `have_default_scope`
+ * `belong_to`
+ * `have_one`
+ * `have_many`
+ * `have_and_belong_to_many`
+ * `validate_associated`
+ * `validate_uniqueness_of`
-## Compatibility
+## Contributing
-Remockable is compatible with Rails 3.0, but it has also been tested against
-3.1 and appears to be working fine there, too.
+1. Fork it.
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Commit your changes (`git commit -am 'Added some feature'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create a new Pull Request.
## Copyright
-Copyright © 2010-2011 Tyler Hunt. See LICENSE for details.
+Copyright © 2010-2012 Tyler Hunt. See LICENSE for details.

0 comments on commit 8b74578

Please sign in to comment.