README.rdoc in devise-1.4.9 vs README.rdoc in devise-1.5.0.rc1

- old
+ new

@@ -1,7 +1,9 @@ == Devise +{<img src="https://secure.travis-ci.org/plataformatec/devise.png" />}[http://travis-ci.org/plataformatec/devise] + Devise is a flexible authentication solution for Rails based on Warden. It: * 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; @@ -26,25 +28,25 @@ === The Devise wiki The Devise Wiki has lots of additional information about Devise including many "how-to" articles and answers to the most frequently asked questions. Please browse the Wiki after finishing this README: -http://wiki.github.com/plataformatec/devise +https://wiki.github.com/plataformatec/devise === Bug reports If you discover a problem with Devise, we would like to know about it. However, we ask that you please review these guidelines before submitting a bug report: -http://github.com/plataformatec/devise/wiki/Bug-reports +https://github.com/plataformatec/devise/wiki/Bug-reports If you found a security bug, do *NOT* use the GitHub issue tracker. Send email or a private GitHub message to the maintainers listed at the bottom of the README. === Mailing list If you have any questions, comments, or concerns, please use the Google Group instead of the GitHub issue tracker: -http://groups.google.com/group/plataformatec-devise +https://groups.google.com/group/plataformatec-devise === RDocs You can view the Devise documentation in RDoc format here: @@ -54,23 +56,23 @@ === Example applications There are a few example applications available on GitHub that demonstrate various features of Devise with different versions of Rails. You can view them here: -http://github.com/plataformatec/devise/wiki/Example-Applications +https://github.com/plataformatec/devise/wiki/Example-Applications === Extensions Our community has created a number of extensions that add functionality above and beyond what is included with Devise. You can view a list of available extensions and add your own here: -http://github.com/plataformatec/devise/wiki/Extensions +https://github.com/plataformatec/devise/wiki/Extensions === Contributing We hope that you will consider contributing to Devise. Please read this short overview for some information about how to get started: -http://github.com/plataformatec/devise/wiki/Contributing +https://github.com/plataformatec/devise/wiki/Contributing You will usually want to write tests for your changes. To run the test suite, `cd` into Devise's top-level directory and run `bundle install` and `rake`. For the tests to pass, you will need to have a MongoDB server (version 1.6 or newer) running on your system. == Installation @@ -287,11 +289,11 @@ reset_password_instructions: subject: 'Reset instructions' Take a look at our locale file to check all available messages. You may also be interested in one of the many translations that are available on our wiki: -http://github.com/plataformatec/devise/wiki/I18n +https://github.com/plataformatec/devise/wiki/I18n === Test helpers Devise includes some tests helpers for functional specs. To use them, you just need to include Devise::TestHelpers in your test class and use the sign_in and sign_out method. Such methods have the same signature as in controllers: @@ -311,11 +313,11 @@ RSpec.configure do |config| config.include Devise::TestHelpers, :type => :controller end -Do not use such helpers for integration tests such as Cucumber or Webrat. Instead, fill in the form or explicitly set the user in session. For more tips, check the wiki (http://wiki.github.com/plataformatec/devise). +Do not use such helpers for integration tests such as Cucumber or Webrat. Instead, fill in the form or explicitly set the user in session. For more tips, check the wiki (https://wiki.github.com/plataformatec/devise). === Omniauth Devise comes with Omniauth support out of the box to authenticate from other providers. You can read more about Omniauth support in the wiki: @@ -327,27 +329,37 @@ === Migrating from other solutions Devise implements encryption strategies for Clearance, Authlogic and Restful-Authentication. To make use of these strategies, you need set the desired encryptor in the encryptor initializer config option and add :encryptable to your model. You might also need to rename your encrypted password and salt columns to match Devise's fields (encrypted_password and password_salt). +== Troubleshooting + +=== Heroku + +Using devise on Heroku with Ruby on Rails 3.1 requires setting: + + config.assets.initialize_on_precompile = false + +Read more about the potential issues at http://guides.rubyonrails.org/asset_pipeline.html + == Additional information === Warden Devise is based on Warden, which is a general Rack authentication framework created by Daniel Neighman. We encourage you to read more about Warden here: -http://github.com/hassox/warden +https://github.com/hassox/warden === Contributors We have a long list of valued contributors. Check them all at: -http://github.com/plataformatec/devise/contributors +https://github.com/plataformatec/devise/contributors === Maintainers -* José Valim (http://github.com/josevalim) -* Carlos Antônio da Silva (http://github.com/carlosantoniodasilva) +* José Valim (https://github.com/josevalim) +* Carlos Antônio da Silva (https://github.com/carlosantoniodasilva) == License -MIT License. Copyright 2010 Plataforma Tecnologia. http://blog.plataformatec.com.br +MIT License. Copyright 2011 Plataforma Tecnologia. http://blog.plataformatec.com.br