Permalink
Browse files

More information about ecosystem in the README.

  • Loading branch information...
1 parent fb832e6 commit 1db86a08101e6bd71b0191e18be1b2302fb14797 @josevalim josevalim committed Apr 15, 2010
Showing with 37 additions and 31 deletions.
  1. +37 −31 README.rdoc
View
@@ -20,43 +20,48 @@ Right now it's composed of 11 modules:
* Validatable: provides validations of email and password. It's optional and can be customized, so you're able to define your own validations.
* Lockable: locks an account after a specified number of failed sign-in attempts. Can unlock via email or after a specified time period.
-== Examples
-
-* Example application using Devise at http://github.com/plataformatec/devise_example
-* Example Rails 2.3 web app combining subdomains with Devise at http://github.com/fortuity/subdomain-authentication
-
-== Dependencies
-
-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 use the latest Rails 3 beta gem with Devise latest gem:
- sudo gem install devise --version=1.1.rc1
+ gem install devise --version=1.1.rc1
After you install Devise and add it to your Gemfile, you need to 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
-
-The documentation above is for Rails 3. If you want to consult the documentation for Rails 2.3, you need to start `gem server` in your own machine. Finally, another good resource for information, is the wiki:
-
- http://wiki.github.com/plataformatec/devise
+And you're ready to go. The generator will install an initializer which describes ALL Devise's configuration options, so don't forget to take a look at it!
== Rails 2.3
If you want to use the Rails 2.3.x version, you should do:
- sudo gem install devise --version=1.0.6
+ gem install devise --version=1.0.6
Or checkout from the v1.0 branch:
http://github.com/plataformatec/devise/tree/v1.0
+== Ecosystem
+
+Devise ecosystem is growing solid day after day. If you just need a walkthrough about setting up Devise, this README will work great. But if you need more documentation and resources, please check both the wiki and rdoc:
+
+* http://rdoc.info/projects/plataformatec/devise
+* http://wiki.github.com/plataformatec/devise
+
+Both links above are for Devise with Rails 3. If you need to use Devise with Rails 2.3, you can always run `gem server` from the command line after you install the gem to access the old documentation.
+
+Another great way to learn Devise are Ryan Bates' screencasts:
+
+* http://railscasts.com/episodes/209-introducing-devise
+
+And a few example applications:
+
+* Rails 2.3 app using Devise at http://github.com/plataformatec/devise_example
+* Rails 2.3 app using Devise with subdomains at http://github.com/fortuity/subdomain-authentication
+
+Finally, Devise also has several extensions built by the community. Don't forget to check them at the end of this README. If you want to write an extension on your own, you should also check Warden (http://github.com/hassox/warden), a Rack Authentication Framework which Devise depends on.
+
== Basic Usage
This is a walkthrough with all steps you need to setup a devise resource, including model, migration, route files, and optional configuration. You MUST also check out the *Generators* section below to help you start.
@@ -133,6 +138,7 @@ Devise allows you to set up as many roles as you want. For example, you may have
t.database_authenticatable
t.lockable
t.trackable
+ t.timestamps
end
# Inside your Admin model
@@ -257,6 +263,18 @@ Devise implements encryption strategies for Clearance, Authlogic and Restful-Aut
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.
+== Extensions
+
+Devise also has extensions created by the community:
+
+* 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.
+
+Please consult their respective documentation for more information and requirements.
+
== TODO
Please refer to TODO file.
@@ -270,14 +288,6 @@ Please refer to TODO file.
We have a long list of valued contributors. See the CHANGELOG or do `git shortlog -s -n` in the cloned repository.
-== 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.
@@ -288,10 +298,6 @@ For support, send an e-mail to the mailing list.
http://groups.google.com/group/plataformatec-devise
-See the wiki for additional documentation and support.
-
-http://wiki.github.com/plataformatec/devise
-
== License
-MIT License. Copyright 2009 Plataforma Tecnologia. http://blog.plataformatec.com.br
+MIT License. Copyright 2010 Plataforma Tecnologia. http://blog.plataformatec.com.br

0 comments on commit 1db86a0

Please sign in to comment.