Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ianwhite committed Mar 16, 2012
1 parent 267580d commit 8e0a60a
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions README.rdoc
Expand Up @@ -3,18 +3,14 @@
is a plugin to facilitate inheritance and DRYness in your resources controllers. It introduces some abstraction to help
you override the default RESTful funtionality in a clean and simple manner.

See History.txt for recent changes.
The gem name is *rc_rails*

== Rails 3 version

Add this to your Gemfile

gem 'resources_controller', :git => 'git://github.com/ianwhite/resources_controller'
gem 'rc_rails'

Or install as a plugin

rails plugin install git://github.com/ianwhite/resources_controller

== Resources

<b>Github</b> for code: http://github.com/ianwhite/resources_controller
Expand All @@ -23,21 +19,22 @@ Or install as a plugin

<b>Google group</b> for questions: http://groups.google.com/group/resources_controller

<b>Lighthouse</b> for bugs: http://ianwhite.lighthouseapp.com/projects/10598-resources_controller

<b>Blog</b> articles: http://blog.ardes.com/resources_controller

<b>RailsConfEurope</b> presentation files: http://en.oreilly.com/railseurope2008/public/schedule/detail/3536

== for rails 2.x

use the rails2 branch: http://github.com/ianwhite/resources_controller/tree/rails2

== Specs and Coverage
== Run the specs

* The SPECDOC lists the specifications
* Coverage is 100% (C0), and the spec suite is quite comprehensive
* Rspec's generated rspec_scaffold controller specs are tested against a simple rc controller (see rake spec:generate)
To get set up for development, do the following:

git clone git://github.com/ianwhite/resources_controller
cd resources_controller
cp Gemfile.lock.development Gemfile.lock
bundle
rake spec:generate
rake spec

== How to contribute

Expand All @@ -54,6 +51,7 @@ To get set up and run the tests

The following people have made contributions to resources_controller. Please let me know if I've missed you out.

* Josh Goebel
* Andrew Bloomgarden
* Chris Hapgood
* Jason Lee
Expand Down

0 comments on commit 8e0a60a

Please sign in to comment.