README.md in token_authenticate_me-0.5.6 vs README.md in token_authenticate_me-0.5.7
- old
+ new
@@ -1,10 +1,14 @@
TokenAuthenticateMe
=====================
This gem adds simple API based token authentication. We at [inigo](http://inigo.io) wanted to be able to handle our entire authentication process -- including account creation and logging in -- through a RESTful API over JSON using token authentication, and found that solutions like Devise required too much hand holding due to its complexity to ultimately get the functionality that we wanted. Unfortunately we were unable to find a satisfactory existing solution -- though I'm sure one does exist, this isn't a new problem -- so we set out to create our own. After using internally on one project, we decided to roll it out into a gem to use on another.
-## Getting started
+## Upgrade Instructions
+ - For all major and minor run: `rails generate token_authenticate_me:install`
+ - Note: Patch version upgrades shouldnt need to run the install command.
+
+## Getting Started
Add the gem to your Gemfile:
`gem token_authenticate_me`
Run `bundle install` to install it.