Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
* Don't couple version updates to README.
* Use consistent English.
* Use correct capitalization of GitHub.
  • Loading branch information
Dan Croak committed Aug 10, 2013
1 parent 5d58a0b commit 7367975
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ Clearance
Rails authentication with email & password.

Clearance was extracted out of [Airbrake](http://airbrake.io/). It is intended
to be small, simple, well-tested, with easy to override defaults.
to be small, simple, and well-tested. It is intended to be easy to override
defaults.

Use [Github Issues](https://github.com/thoughtbot/clearance/issues) for help.
Use [GitHub Issues](https://github.com/thoughtbot/clearance/issues) for help.

Read [CONTRIBUTING.md](/CONTRIBUTING.md) to contribute.

Expand All @@ -23,7 +24,7 @@ It works with Rails 4 and Ruby 2.
Include the gem in your Gemfile:

```ruby
gem 'clearance', '1.0.0'
gem 'clearance'
```

Bundle:
Expand All @@ -43,10 +44,11 @@ The generator:

Then, follow the instructions output from the generator.

Use Clearance [0.8.8](https://github.com/thoughtbot/clearance/tree/v0.8.8)
series for Rails 2 apps.
Use Clearance [0.8.8](https://github.com/thoughtbot/clearance/tree/v0.8.8) for
Rails 2 apps.

Use [0.16.3](http://rubygems.org/gems/clearance/versions/0.16.3) for Ruby 1.8.7.
Use Clearance [0.16.3](http://rubygems.org/gems/clearance/versions/0.16.3) for
Ruby 1.8.7 apps.

Configure
---------
Expand Down

0 comments on commit 7367975

Please sign in to comment.