README.rdoc in devise-1.1.pre4 vs README.rdoc in devise-1.1.rc0

- old
+ new

@@ -5,15 +5,14 @@ * Is Rack based; * Is a complete MVC solution based on Rails engines; * Allows you to have multiple roles (or models/scopes) signed in at the same time; * Is based on a modularity concept: use just what you really need. -Right now it's composed of 12 modules: +Right now it's composed of 11 modules: -* Authenticatable: encrypts a password and validates the authenticity of a user while signing in. -* Token Authenticatable: validates the authenticity of a user while signing in using an authentication token (also known as "single access token"). -* HttpAuthenticatable: sign in users using basic HTTP authentication. +* Database Authenticatable: encrypts and stores a password in the database to validate the authenticity of an user while signing in. The authentication can be done both through POST requests or HTTP Basic Authentication. +* Token Authenticatable: signs in an user based on an authentication token (also known as "single access token"). The token can be given both through query string or HTTP Basic Authentication. * Confirmable: sends emails with confirmation instructions and verifies whether an account is already confirmed during sign in. * Recoverable: resets the user password and sends reset instructions. * Registerable: handles signing up users through a registration process. * Rememberable: manages generating and clearing a token for remembering the user from a saved cookie. * Trackable: tracks sign in count, timestamps and IP address. @@ -31,32 +30,27 @@ Devise is based on Warden (http://github.com/hassox/warden), a Rack Authentication Framework. You need to install Warden as a gem. Please ensure you have it installed in order to use Devise (see installation below). == Installation -Devise master branch now supports Rails 3 and is NOT backward compatible. You can install it as: +Devise master branch now supports Rails 3 and is NOT backward compatible. If you are using Rails 3.0.0 beta gem, you need to install devise as a gem: - sudo gem install devise --version=1.1.pre + sudo gem install devise --version=1.1.pre4 -After installing the Warden and Devise gems, you need to configure the gems inside your gemfile: +However, if you are using Rails edge, from the git repository, you also need to use Devise from the git repository. After you install Devise and add it to your gemfile, you need to run the generator: - gem 'warden' - gem 'devise' + rails generate devise_install -And run the generator: - - rails generate devise_install - And you're ready to go. The generator will install an initializer which describes ALL Devise's configuration options, so be sure to take a look at it and at the documentation as well: http://rdoc.info/projects/plataformatec/devise == Rails 2.3 If you want to use the Rails 2.3.x version, you should do: - sudo gem install devise --version=1.0.1 + sudo gem install devise --version=1.0.4 Or checkout from the v1.0 branch: http://github.com/plataformatec/devise/tree/v1.0 @@ -254,11 +248,11 @@ Devise implements encryption strategies for Clearance, Authlogic and Restful-Authentication. To make use of these strategies, set the desired encryptor in the encryptor initializer config option. You might also need to rename your encrypted password and salt columns to match Devise's fields (encrypted_password and password_salt). == Other ORMs -Devise supports ActiveRecord (by default) and MongoMapper. We offer experimental Datamapper support (with the limitation that the Devise test suite does not run completely with Datamapper). To choose other ORM, you just need to configure it in the initializer file. +Devise supports ActiveRecord (by default) and Mongoid. We offer experimental Datamapper support (with the limitation that the Devise test suite does not run completely with Datamapper). To choose other ORM, you just need to configure it in the initializer file. == TODO Please refer to TODO file. @@ -269,14 +263,16 @@ == Contributors We have a long list of valued contributors. See the CHANGELOG or do `git shortlog -s -n` in the cloned repository. -== Related Applications +== Devise extensions * http://github.com/scambra/devise_invitable adds support to Devise for sending invitations by email. * http://github.com/grimen/devise_facebook_connectable adds support for Facebook Connect authentication, and optionally fetching user info from Facebook in the same step. + +* http://github.com/joshk/devise_imapable adds support for imap based authentication, excellent for internal apps when an LDAP server isn't available. == Bugs and Feedback If you discover any bugs, please create an issue on GitHub.