Skip to content

Commit

Permalink
Re-order some of our content (#43)
Browse files Browse the repository at this point in the history
* Re-order some of our content

* Added linebreak

* touchup

* version bump
  • Loading branch information
bhennes2 authored and inveterateliterate committed May 5, 2017
1 parent 4cab61f commit fbdee5f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,10 @@
* [Quick Start](#quick-start)
* [Details](#details)
* [FAQ](#faq)
* [Comparisons](#comparisons)

## Motivation
Whenever your application manages users, you will inevitably need to handle email confirmation, password reset, user invitations, and other authentication flows. While not too complicated, they are sort of annoying to implement and some great libraries have our backs. [Devise][devise] and [Sorcery][sorcery] are great options that we have used in the past, but we found ourselves wanting both a little less and a little more.

### Devise
[Devise][devise] is an amazing gem! It is perfect when you want an all-in-one solution that handles user authentication and associated flows for your Rails/ERB app. Everything is in the box, including the routes, controllers, views, and even mailers to handle user auth. But we often use Rails as an API and/or wanted more control over all those pieces and it became difficult to peel back all the layers to just to confirm a user's email.

### Sorcery
[Sorcery][sorcery] is great and we highly recommend it. It is closer to what we wanted but still was a bit more than we needed and even the < 20 methods seemed like more than necessary.
Whenever your application manages users, you will inevitably need to handle email confirmation, password reset, user invitations, and other authentication flows. While not too complicated, they are sort of annoying to implement and some great libraries have our backs. [Devise][devise] and [Sorcery][sorcery] are great options that we have used in the past, but we found ourselves wanting both a little less and a little more. See our more detailed thoughts on these options [below](#comparisons).

### User Authentication Flows
Email confirmation, password reset, user invitations are all variations of the same process:
Expand Down Expand Up @@ -300,6 +295,16 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Launch

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

---------------------------

## Comparisons

### Devise
[Devise][devise] is an amazing gem! It is perfect when you want an all-in-one solution that handles user authentication and associated flows for your Rails/ERB app. Everything is in the box, including the routes, controllers, views, and even mailers to handle user auth. But we often use Rails as an API and/or wanted more control over all those pieces and it became difficult to peel back all the layers to just to confirm a user's email.

### Sorcery
[Sorcery][sorcery] is great and we highly recommend it. It is closer to what we wanted but still was a bit more than we needed and even the < 20 methods seemed like more than necessary.

<!-- Links -->
[devise]: https://github.com/plataformatec/devise
[sorcery]: https://github.com/Sorcery/sorcery
Expand Down
2 changes: 1 addition & 1 deletion lib/token_master/version.rb
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module TokenMaster
# Current version of TokenMaster
VERSION = '0.1.3'.freeze
VERSION = '0.1.4'.freeze
end

0 comments on commit fbdee5f

Please sign in to comment.