0
@@ -1,4 +1,4 @@
0
-This is the Thoughtbot Rails Template.  To create a new project, checkout this
0
+This is Suspenders, the thoughtbot rails template.  To create a new project, checkout this
0
 repository and run:
0
 
0
   ./script/create_project.rb projectname
0
@@ -12,4 +12,99 @@ When making a change to a project that was created via this template, consider
0
 whether it's a change that should be made across all projects.  If so, then
0
 make the change in this template, and pull it into your project via:
0
 
0
-  git pull git@github.com:thoughtbot/suspenders.git master
0
\ No newline at end of file
0
+  git pull git@github.com:thoughtbot/suspenders.git master
0
+  
0
+  
0
+About Suspenders
0
+
0
+Suspenders was created for use at thoughtbot, inc. (http://www.thoughtbot.com) as a
0
+baseline application setup, with reasonable default plugins that the majority (if not all)
0
+of our applications used, as well as best-practice configuration options.
0
+
0
+Suspenders currently includes Rails 2.1.1
0
+
0
+Gems (unpacked in vendor/gems):
0
+
0
+  will_paginate 2.3.4
0
+  RedCloth 3.0.4
0
+
0
+  For testing:
0
+    mocha 0.9.1
0
+    factory_girl 1.1.3
0
+    shoulda 2.0.2
0
+    quietbacktrace
0
+  
0
+Plugins (in vendor/plugins):
0
+
0
+  hoptoad_notifier
0
+  mile_marker
0
+  squirrel
0
+  tb_common_tasks
0
+
0
+  For testing:
0
+    helper_test
0
+    
0
+Initializers (in config/initializers)
0
+
0
+  action_mailer_configs.rb
0
+  We use SMTP by default in all applications.
0
+
0
+  hoptoad.rb
0
+  Get your API key at http://hoptoadapp.com
0
+  
0
+  requires.rb
0
+  Automatically requires everything in
0
+    lib/
0
+    lib/extensions
0
+    test/mocks/RAILS_ENV (Removed in Rails 2, we decided to keep it)
0
+  Add other things you need to require in here.
0
+
0
+  time_formats.rb
0
+  Two time formats are available by default, :short_date and :long_date.
0
+  Add other time formats here.
0
+  
0
+Rake Tasks
0
+
0
+  bootstrap
0
+  Provides rake tasks for loading data into the database.  These are used for an initial application dataset needed for production.
0
+  
0
+  capstrano
0
+  Standard capistrano deployment tasks
0
+  
0
+  git_tasks
0
+  Tasks for deployment management to staging and production when using git.
0
+  
0
+Testing
0
+
0
+  Testing is done utilizing Test::Unit, Shoulda, factory_girl, and mocha.
0
+  
0
+  factory_girl is a fixture replacement library, following the factory pattern.  Place your
0
+  factories in test/factories.rb.  The fixture directory has been removed, as fixtures are not
0
+  used.
0
+  
0
+  Shoulda is a pragmatic testing framework for TDD and BDD built on top of Test::Unit.  A number of additional
0
+  testing macros are provided in test/shoulda_macros.
0
+    shoulda_have_form
0
+    shoulda_paginate_collection
0
+
0
+Deployment
0
+
0
+  Deployment is done using capistrano, and deploys to a mongrel cluster, running under Apache.
0
+  
0
+  Rake tasks are provided for managing git branches which the different environments pull from
0
+  for deploy.
0
+  
0
+  To push the git master to git staging branch run
0
+    rake git:push:staging
0
+  To push the git staging branch to production branch run
0
+    rake git:push:production
0
+  
0
+  Setup your deployment environment by running 
0
+    cap ENVIRONMENT deploy:setup
0
+    (You'll be prompted for the environment's database password)
0
+  
0
+  Deploy to the desired environment by running
0
+    cap ENVIRONMENT deploy
0
+    
0
+  The default environment for deploy is staging, to deploy to staging, just run
0
+    cap deploy
0
\ No newline at end of file