Skip to content

Commit

Permalink
more updates to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Max Spransy authored and Max Spransy committed Dec 14, 2010
1 parent d35f79a commit 3ded7a0
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions readme.markdown
@@ -1,8 +1,8 @@
### A little sinatra gem that implements user authentication, with support for Datamapper, Mongomapper, Sequel and Rufus-Tokyo
### A little sinatra gem that implements user authentication, with support for Datamapper, Mongomapper, Mongoid, Sequel and Rufus-Tokyo

## INSTALLATION:

in your sinatra app simply require either "dm-core", 'sequel', "rufus-tokyo" or "mongo_mapper", "digest/sha1", 'rack-flash' (if you want flash messages) and then "sinatra-authentication" and turn on session storage
in your sinatra app simply require either "dm-core", 'sequel', 'rufus-tokyo', 'mongoid' or "mongo_mapper", "digest/sha1", 'rack-flash' (if you want flash messages) and then "sinatra-authentication" and turn on session storage
with a super secret key, like so:

require "dm-core"
Expand Down Expand Up @@ -30,8 +30,6 @@ with a super secret key, like so:
#if you want flash messages
use Rack::Flash

*Note that Sequel support isn't in the gem version yet*

## DEFAULT ROUTES:

* get '/login'
Expand Down Expand Up @@ -253,6 +251,8 @@ The database user classes are named as follows:
> SequelUser
* for Rufus Tokyo:
> TcUser
* for Mongoid:
> MongoidUser
* for Mongomapper:
> MmUser
Expand All @@ -262,7 +262,8 @@ The database user classes are named as follows:
## Roadmap

* Move database adapter initialization, along with auto configuration of sinbook and rack flash functionality into a Sinatra::SinatraAuthentication.init(args) method
* Refactor/redesign database adapter interface, with corresponding specs
* Refactor/redesign database adapter interface, make User class AbstractUser and all ORM user classes User, with corresponding specs
* Remove Facebook connect support and add support for Omniauth
* Provide a method for overriding specific views, and/or specifying your own form partial, (passed an instance of User)
* Add Remember me (forever) checkbox to login form
* Add next url parameter support for login/signup
Expand All @@ -272,8 +273,6 @@ The database user classes are named as follows:
* Add email functionality
> Confirmation emails
> Forgotten password emails
* Add pluggable Twitter OAuth support
> Along with 'login using twitter' buttons in views
* Look into what might be neccesary to allow for logging in using Ajax

## Maybe
Expand Down

0 comments on commit 3ded7a0

Please sign in to comment.