Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

tweak README

  • Loading branch information...
commit 2a2d42c7009c8d6d35a08758b8bab1529c1413aa 1 parent 97ab9c2
@fortuity authored
Showing with 27 additions and 31 deletions.
  1. +27 −31 README.textile
View
58 README.textile
@@ -1,6 +1,6 @@
h1. Rails3 + Mongoid + Devise
-This example app combines "Mongoid":http://mongoid.org/ with "Devise":http://github.com/plataformatec/devise for a Rails 3 starter app. Mongoid is a datastore that gives you quick development without schemas or migrations. Devise gives you ready-made authentication and user management.
+This is an example *Rails 3 application* that combines *Devise* with *Mongoid*. The "Devise":http://github.com/plataformatec/devise gem gives you ready-made authentication and user management. MongoDB is used as a datastore with the "Mongoid":http://mongoid.org/ gem for quick development without schemas or migrations.
Best of all, there's a "detailed tutorial":http://github.com/fortuity/rails3-mongoid-devise/wiki/Tutorial-%28Walkthrough%29 (walk-through) to show how it's built.
@@ -23,33 +23,25 @@ The tutorial documents each step to follow to create the application. Every step
If you simply wish to modify the application for your own project, you can download the application and set it up as described below, without following the tutorial.
-h2. Similar Applications
-
-h4. "Plataformatec's Simple Devise Example":http://github.com/plataformatec/devise_example
-
-Simple Devise example using SQLite for Rails 3.
-
-h4. "Rails3 + Devise + RSpec + Cucumber":https://github.com/fortuity/rails3-devise-rspec-cucumber
-
-Daniel Kehoe's example Rails 3 app with Devise + RSpec + Cucumber. With a detailed tutorial.
-
-h4. "Fernando Tapia Rico's rails3-mongoid-devise-omniauth with Tutorial":https://github.com/fertapric/rails3-mongoid-devise-omniauth
-
-Extended with "OmniAuth":https://github.com/intridea/omniauth (for authentication via OpenID, Facebook, OAuth, etc.)
-
-h4. "Andi Altendorfer's CBA":http://github.com/iboard/CBA
+h2. What Is Implemented -- and What Is Not
-Extended with "OmniAuth":https://github.com/intridea/omniauth (for authentication via OpenID, Facebook, OAuth, etc.), "CanCan":https://github.com/ryanb/cancan (adding authorization by roles), and "Paperclip":https://github.com/thoughtbot/paperclip (for avatars).
+This is a demonstration application that allows you to visit a home page and see a list of users. With the default user's email and password (supplied below), you can log in and view details for each user. You can customize this app as you need.
-h4. "Kristian Mandrup's Cream":https://github.com/kristianmandrup/cream
+h4. Similar Examples and Tutorials
-Integrates Devise, Roles, and CanCan with Permits. For Mongoid or other ORMs.
+|_. Author |_. Devise |_. Comments |
+| Plataformatec | "Rails 3 Devise Example":http://github.com/plataformatec/devise_example | Simple example using SQLite |
+| Daniel Kehoe | "Rails 3, Devise, RSpec, Cucumber":https://github.com/fortuity/rails3-devise-rspec-cucumber | Detailed tutorial, app template, starter app, using SQLite |
-h2. What Is Implemented -- and What Is Not
+|_. Author |_. OmniAuth |_. Comments |
+| Daniel Kehoe | "Rails 3, OmniAuth, Mongoid":https://github.com/fortuity/rails3-mongoid-omniauth | Detailed tutorial, app template, starter app, using MongoDB |
-This is a barebones application that serves to demonstrate Mongoid and Devise working on Rails 3.
+|_. Author |_. Devise with OmniAuth |_. Comments |
+| Fernando Tapia Rico | "Rails 3, Devise, OmniAuth, Mongoid":https://github.com/fertapric/rails3-mongoid-devise-omniauth | With tutorial, using MongoDB |
-All you can do is visit a home page and see a list of users. With the default user's email and password (supplied below), you can log in and view details for each user. You can customize this app as you need.
+|_. Author |_. Extended Apps |_. Comments |
+| Andi Altendorfer | "Community Base Application (CBA)":http://github.com/iboard/CBA | Devise, OmniAuth, Mongoid, CanCan, Paperclip, etc. |
+| Kristian Mandrup | "Cream":https://github.com/kristianmandrup/cream | Gem-based app generator for apps with Devise, many ORMs, CanCan |
h2. Dependencies
@@ -127,10 +119,10 @@ h3. About Required Gems
The application uses the following gems. I recommend checking for newer versions of these gems before proceeding:
-* rails "(check rubygems.org for the rails gem)":http://rubygems.org/gems/rails
-* mongoid "(Check rubygems.org for the mongoid gem)":http://rubygems.org/gems/mongoid
-* bson_ext "(Check rubygems.org for the bson_ext gem)":http://rubygems.org/gems/bson_ext
-* devise "(Check rubygems.org for the devise gem)":http://rubygems.org/gems/devise
+* rails "(check rubygems.org for a newer gem)":http://rubygems.org/gems/rails
+* mongoid "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/mongoid
+* bson_ext "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/bson_ext
+* devise "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/devise
If you are able to build the app with a newer gem, please create an "issue":http://github.com/fortuity/rails3-mongoid-devise/issues on GitHub and I will update the app.
@@ -338,7 +330,9 @@ For a Mongoid introduction, Ryan Bates offers a "Railscast on Mongoid":http://ra
For a Devise introduction, Ryan Bates offers a "Railscast on Devise":http://railscasts.com/episodes/209-introducing-devise. You can find documentation for "Devise":http://github.com/plataformatec/devise at "http://github.com/plataformatec/devise":http://github.com/plataformatec/devise. There is an active "Devise mailing list":http://groups.google.com/group/plataformatec-devise and you can submit "Devise issues":http://github.com/plataformatec/devise/issues at GitHub.
-This application is provided without additional documentation or support.
+h4. Issues
+
+Please create an "issue on GitHub":http://github.com/fortuity/rails3-mongoid-devise/issues if you identify any problems or have suggestions for improvements.
h2. Contributing
@@ -356,13 +350,15 @@ Is the app useful to you? Follow the project on Twitter:
"http://twitter.com/rails_apps":http://twitter.com/rails_apps
and tweet some praise. I'd love to know you were helped out by what I've put together.
-Any issues? Please create an "Issue":http://github.com/fortuity/rails3-mongoid-devise/issues on GitHub.
-
h4. Contributors
-Thank you to contributor "Nakort Valles":https://github.com/Nakort for updating to newer gems.
+Thank you for improvements to the tutorial by contributors:
-Thank you for improvements to the tutorial by contributors "Cory Foy":https://github.com/CoryFoy, "Luca G. Soave":https://github.com/lgs, "Bob Clewell":https://github.com/bobclewell, and "Justin Workman":https://github.com/xtagon.
+* "Cory Foy":https://github.com/CoryFoy
+* "Luca G. Soave":https://github.com/lgs
+* "Bob Clewell":https://github.com/bobclewell
+* "Justin Workman":https://github.com/xtagon
+* "Tom von Schwerdtner":https://github.com/tvon
h2. License
Please sign in to comment.
Something went wrong with that request. Please try again.