update README

Author: DanielKehoe

README

@@ -12,6 +12,6 @@ https://github.com/railsapps/rails3-devise-rspec-cucumber
 
 ________________________
 
-Public Domain Dedication
+MIT License
 
-This work is a compilation and derivation from other previously released works. With the exception of various included works, which may be restricted by other licenses, the author or authors of this code dedicate any and all copyright interest in this code to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this code under copyright law.
+http://www.opensource.org/licenses/mit-license

README.textile

@@ -8,26 +8,26 @@ Rails 3.2 example application shows how to use "Devise":http://github.com/plataf
 
 Best of all, there's a "detailed tutorial":http://railsapps.github.com/tutorial-rails-devise-rspec-cucumber.html to show how it's built.
 
-You can clone this app or generate a new Rails application using an "application template":https://github.com/RailsApps/rails3-application-templates.
+You can build this application in only a few minutes using the "Rails Composer":http://railsapps.github.com/rails-composer/ tool.
 
 h2. !http://twitter-badges.s3.amazonaws.com/t_logo-a.png(Follow on Twitter)!:http://www.twitter.com/rails_apps Follow on Twitter
 
 Follow the project on Twitter: "@rails_apps":http://twitter.com/rails_apps. Please tweet some praise if you like what you've found.
 
 h2. Tutorial
 
-A complete walkthrough tutorial is available on the GitHub wiki:
+A complete tutorial is available:
 
 h4. "View the Tutorial":http://railsapps.github.com/tutorial-rails-devise-rspec-cucumber.html
 
 The tutorial documents each step to follow to create the application. Every step is documented concisely, so a complete beginner can create this application without any additional knowledge. However, no explanation is offered for any of the steps, so if you are a beginner, you’re advised to look for an introduction to Rails elsewhere. See a list of recommended resources for "Rails":http://railsapps.github.com/rails.html.
 
-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. What Is Implemented -- and What Is Not
 
 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. Devise provides user management so a visitor can register with an email address and password and create an account. Devise provides authentication so access to the site can be limited to users who are registered and logged in.
 
+The @rake db:seed@ command sets up a database with two example users. The first user is designated as an administrator and can view a administrative page when logged in. The second user is restricted from accessing the administrative page.
+
 h4. Similar Examples and Tutorials
 
 This is one in a series of Rails example apps and tutorials from the "RailsApps Project":http://railsapps.github.com/. See a list of additional "Rails examples, tutorials, and starter apps":http://railsapps.github.com/rails-examples-tutorials.html.
@@ -45,124 +45,80 @@ Before generating your application, you will need:
 * The Ruby language (version 1.9.3)
 * Rails 3.2
 
-See "Installing Rails 3.2":http://railsapps.github.com/installing-rails.html for detailed instructions and advice.
+See the article "Installing Rails":http://railsapps.github.com/installing-rails.html for advice about updating Rails and your development environment.
 
 h2. Getting the Application
 
 You have several options for getting the code.
 
-h4. Fork, Clone, or Generate?
-
-_Fork:_ If you'd like to add features (or bug fixes) to improve the example application, you can fork the GitHub repo and "make pull requests":http://help.github.com/send-pull-requests/. Your code contributions are welcome!
-
-_Clone:_ If you want to copy and customize the app with changes that are only useful for your own project, you can clone the GitHub repo. You'll need to search-and-replace the project name throughout the application. You probably should generate the app instead (see below).
+h3. Fork
 
-_Generate:_ If you want to use the project as a starter app for your customized application, use the application template to generate a new version of the example app. You'll be able to give it your own project name when you generate the app. Generating the application (described below) gives you many options, such as using Haml for views, additional Devise modules, and various HTML5/CSS front-end frameworks such as Twitter Bootstrap.
+If you'd like to add features (or bug fixes) to improve the example application, you can fork the GitHub repo and "make pull requests":http://help.github.com/send-pull-requests/. Your code contributions are welcome!
 
-h4. Clone the Repository
+h3. Clone
 
-If you simply wish to examine the example code, you can download the code ("clone the repository") with the command
+If you want to copy and customize the app with changes that are only useful for your own project, you can clone the GitHub repo. You'll need to search-and-replace the project name throughout the application. You probably should generate the app instead (see below). To clone:
 
 <pre>
 $ git clone git://github.com/RailsApps/rails3-devise-rspec-cucumber.git
 </pre>
 
-The source code is managed with Git (a version control system). You'll need Git on your machine (install it from "http://git-scm.com/":http://git-scm.com/).
+You'll need "git":http://git-scm.com/ on your machine. See "Rails and Git":http://railsapps.github.com/rails-git.html.
 
-h4. Using the Ready-Made Application Template
+h3. Generate
 
-You can use an application template to generate a new version of the example app. You’ll find an application template for this app in the "Rails Application Templates":https://github.com/RailsApps/rails3-application-templates repository.
+If you want to use the project as a starter app, use the "Rails Composer":http://railsapps.github.com/rails-composer/ tool to generate a new version of the example app. You'll be able to give it your own project name when you generate the app. Generating the application gives you many additional options.
 
-To build the "rails3-devise-rspec-cucumber" example application, run the command:
+To build the example application, run the command:
 
 <pre>
-$ rails new myapp -m https://github.com/RailsApps/rails3-application-templates/raw/master/rails3-devise-rspec-cucumber-template.rb -T
+$ rails new myapp -m https://raw.github.com/RailsApps/rails-composer/master/composer.rb -T
 </pre>
 
 Use the @-T@ flag to skip Test::Unit files.
 
 The @$@ character indicates a shell prompt; don't include it when you run the command.
 
-This creates a new Rails app (with the name @myapp@) on your computer.
-
-The application generator templates will ask you for various preferences.
-
-To reproduce the example application exactly as found in the repository, make the following selections:
-
-* Would you like to use "Haml":http://en.wikipedia.org/wiki/Haml instead of ERB? *no*
-* Would you like to use "RSpec":http://rspec.info/ instead of TestUnit? *yes*
-* Would you like to use "factory_girl":https://github.com/thoughtbot/factory_girl for test fixtures with RSpec? *yes*
-* Would you like to use "machinist":https://github.com/notahat/machinist for test fixtures with RSpec? *no*
-* Would you like to use "Cucumber":http://cukes.info/ for your BDD? *yes*
-* Would you like to use "Guard":http://intridea.com/posts/hire-a-guard-for-your-project to automate your workflow? *no*
-* Would you like the app to use a Gmail account to send email? *yes*
-* Would you like to use "Devise":http://github.com/plataformatec/devise for authentication?
-## No
-## Devise with default modules *#2*
-## Devise with Confirmable module
-## Devise with Confirmable and Invitable modules
-* Would you like to manage authorization with CanCan & Rolify? *no*
-* Which front-end framework would you like for HTML5 and CSS3?
-## None *#1*
-## "Zurb Foundation":http://foundation.zurb.com/
-## "Twitter Bootstrap":http://twitter.github.com/bootstrap/ (less)
-## "Twitter Bootstrap":http://twitter.github.com/bootstrap/ (sass)
-## "Skeleton":http://www.getskeleton.com/
-## Normalize CSS for consistent styling
-* Which form gem would you like?
-## None *#1*
-## simple form
-## simple form (bootstrap)
-* Would you like to use "rails-footnotes":https://github.com/josevalim/rails-footnotes during development? *no*
-* Would you like to set a robots.txt file to ban spiders? *yes*
-* Would you like to add 'will_paginate' for pagination? *no*
-* Add 'therubyracer' JavaScript runtime (for Linux users without node.js)? *no*
-
-You can choose other selections if you don't care about matching the example application exactly.
-
-h4. Use "Recipes" to Customize an Application Template
-
-The application template was created using the "rails_apps_composer":https://github.com/RailsApps/rails_apps_composer gem which provides a convenient way to assemble a reusable application template by selecting various "recipes" for popular Rails development packages. Use "rails_apps_composer":https://github.com/RailsApps/rails_apps_composer if you want to customize the application template for your own starter apps.
-
-h4. Edit the README
-
-If you're open sourcing the app on GitHub, please edit the README file to add a description of the app and your contact info. Changing the README is important if you're using a clone of the example app. I've been mistaken (and contacted) as the author of apps that are copied from my example.
+This creates a new Rails app (with the name "myapp") on your computer.
 
-h2. Getting Started
+h3. Edit the README
 
-h4. About Required Gems
+If you're storing the app in a GitHub repository, please edit the README files to add a description of the app and your contact info. If you don't change the README, people will think I am the author of your version of the application.
 
-The application uses the following gems:
+h2. Getting Started
 
-* "rails":http://rubygems.org/gems/rails
-* "rspec-rails":http://rubygems.org/gems/rspec-rails
-* "database_cleaner":http://rubygems.org/gems/database_cleaner
-* "factory_girl_rails":http://rubygems.org/gems/factory_girl_rails
-* "cucumber-rails":http://rubygems.org/gems/cucumber-rails
-* "capybara":http://rubygems.org/gems/capybara
-* "devise":http://rubygems.org/gems/devise
+h3. Install the Required Gems
 
-See "Example Gemfiles for Rails 3.2":http://railsapps.github.com/rails-3-2-example-gemfile.html.
+Check the Gemfile to see which gems are used by this application.
 
-h4. Install the Required Gems
+If you used the "Rails Composer":http://railsapps.github.com/rails-composer/ tool to generate the example app, the application template script has already run the @bundle install@ command.
 
-Install the required gems on your computer:
+If not, you should run the @bundle install@ command to install the required gems on your computer:
 
-@$ bundle install@
+<pre>
+$ bundle install
+</pre>
 
 You can check which gems are installed on your computer with:
 
-@$ gem list --local@
+<pre>
+$ gem list
+</pre>
 
 Keep in mind that you have installed these gems locally. When you deploy the app to another server, the same gems (and versions) must be available.
 
-h2. Configure Email
+I recommend using "rvm":https://rvm.io/, the Ruby Version Manager, to create a project-specific gemset for the application. See the article "Installing Rails":http://railsapps.github.com/installing-rails.html.
 
-You must configure the app for your email account if you want your application to send email messages, for example, if you've generated the application with the option to install the Devise @:confirmable@ module. 
+h3. Configure Email
+
+You must configure the app for your email account if you want your application to send email messages. 
 
 h4. Use a Gmail account
 
-If you've generated the application with the option to use a Gmail account to send email, you'll need to modify the files *config/environments/development.rb* and *config/environments/production.rb* to include your Gmail username and password.
+You'll need to modify two files to include your Gmail username and password:
+
+* *config/environments/development.rb*
+* *config/environments/production.rb*
 
 <pre>
 config.action_mailer.smtp_settings = {
@@ -191,29 +147,32 @@ Open a new shell or restart your terminal application to continue.
 
 h4. Configure ActionMailer
 
-The example application is set to deliver email in both development and production. It will raise delivery errors in development but not production. 
+The example application is set to deliver email in production only. It will raise delivery errors in development but not production. 
 
 In development, @config.action_mailer.default_url_options@ is set for a host at @localhost:3000@ which will enable links in Devise confirmation email messages to work properly. You'll need to change the @config.action_mailer.default_url_options@ host option from @example.com@ to your own domain for the production environment.
 
-You can change these values as needed in the *config/environments/development.rb* and *config/environments/production.rb* files.
+You can change these values as needed in these two files:
+
+* *config/environments/development.rb*
+* *config/environments/production.rb*
 
 h4. Configure Devise for Email
 
 Complete your email configuration by modifying
 
-*config/initializers/devise.rb*
+* *config/initializers/devise.rb*
 
 and setting the @config.mailer_sender@ option for the return email address for messages that Devise sends from the application.
 
 h2. Configure Devise
 
 You can modify the configuration file for Devise if you want to use something other than the defaults:
 
-*config/initializers/devise.rb*
+* *config/initializers/devise.rb*
 
 h2. Create a Default User
 
-h4. Set Up a Database Seed File
+h3. Set Up a Database Seed File
 
 You'll want to set up a default user so you can easily log in to test the app. You can modify the file *db/seeds.rb* for your own name, email and password:
 
@@ -223,27 +182,28 @@ user = User.create! :name => 'First User', :email => '[email protected]', :passwo
 puts 'New user created: ' << user.name
 user2 = User.create! :name => 'Second User', :email => '[email protected]', :password => 'please', :password_confirmation => 'please'
 puts 'New user created: ' << user2.name
+user.add_role :admin
 </pre>
 
 Use the defaults or change the values for name, email, and password as you wish.
 
-If you've generated the application with the option to install the Devise @:confirmable@ module, there will be an extra attribute @confirmed_at => Time.now@ for creation of a user.
-
-h4. Set the Database
+h3. Set the Database
 
 Prepare the database and add the default user to the database by running the commands:
 
 <pre>
-$ bundle exec rake db:migrate
-$ bundle exec rake db:seed
+$ rake db:migrate
+$ rake db:seed
 </pre>
 
 Set the database for running tests:
 
 <pre>
-$ bundle exec rake db:test:prepare
+$ rake db:test:prepare
 </pre>
 
+If you’re not using "rvm":https://rvm.io/, the Ruby Version Manager, you should preface each rake command with @bundle exec@. You don’t need to use @bundle exec@ if you are using rvm version 1.11.0 or newer.
+
 h2. Test the App
 
 You can check that your app runs properly by entering the command
@@ -259,6 +219,8 @@ To sign in as the default user, (unless you've changed it) use
 
 You should delete or change the pre-configured logins before you deploy your application.
 
+If you test the app by starting the web server and then leave the server running while you install new gems, you’ll have to restart the server to see any changes. The same is true for changes to configuration files in the config folder. This can be confusing to new Rails developers because you can change files in the app folders without restarting the server. Stop the server each time after testing and you will avoid this issue.
+
 h2. Deploy to Heroku
 
 For your convenience, here is a "Tutorial for Rails on Heroku":http://railsapps.github.com/rails-heroku-tutorial.html. Heroku provides low cost, easily configured Rails application hosting.
@@ -291,7 +253,7 @@ Are you getting an error "OpenSSL certificate verify failed" when you try to gen
 
 h2. Documentation and Support
 
-This is the only documentation.
+The "tutorial":http://railsapps.github.com/tutorial-rails-devise-rspec-cucumber.html provides additional documentation.
 
 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.
 
@@ -315,7 +277,7 @@ If you add functionality to this application, create an alternative implementati
 
 h2. Credits
 
-Daniel Kehoe ("http://danielkehoe.com/":http://danielkehoe.com/) implemented the application and wrote the tutorial.
+Daniel Kehoe implemented the application and wrote the tutorial.
 
 Is the app useful to you? Follow the project on Twitter: "@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.