diff --git a/README.rdoc b/README.rdoc index f852cfe..6256894 100644 --- a/README.rdoc +++ b/README.rdoc @@ -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 Github for code: http://github.com/ianwhite/resources_controller @@ -23,21 +19,22 @@ Or install as a plugin Google group for questions: http://groups.google.com/group/resources_controller -Lighthouse for bugs: http://ianwhite.lighthouseapp.com/projects/10598-resources_controller - -Blog articles: http://blog.ardes.com/resources_controller - RailsConfEurope 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 @@ -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