README.md in clearance-1.12.1 vs README.md in clearance-1.13.0

- old
+ new

@@ -14,26 +14,34 @@ monitored by contributors. [GitHub Issues]: https://github.com/thoughtbot/clearance/issues [Stack Overflow]: http://stackoverflow.com/questions/tagged/clearance -## Install +## Getting Started Clearance is a Rails engine tested against Rails `>= 3.2` and Ruby `>= 1.9.3`. -To get started, add Clearance to your `Gemfile`, `bundle install`, and run the -`install generator`: +You can add it to your Gemfile with: + ```sh +gem 'clearance' +``` + +Run the bundle command to install it. + +After you install Clearance, you need to run the generator: + +```sh $ rails generate clearance:install ``` -The generator: +The Clearance install generator: * Inserts `Clearance::User` into your `User` model * Inserts `Clearance::Controller` into your `ApplicationController` -* Creates an initializer to allow further configuration. -* Creates a migration that either creates a users table or adds any necessary +* Creates an initializer file to allow further configuration. +* Creates a migration file that either create a users table or adds any necessary columns to the existing table. ## Configure Override any of these defaults in `config/initializers/clearance.rb`: @@ -341,10 +349,10 @@ $ rails generate clearance:specs ``` ### Controller Test Helpers -To test controller actions that are protected by `before_filter :require_login`, +To test controller actions that are protected by `before_action :require_login`, require Clearance's test helpers in your test suite. For `rspec`, add the following line to your `spec/rails_helper.rb` or `spec/spec_helper` if `rails_helper` does not exist: