README.rdoc in blavosync-0.2.3 vs README.rdoc in blavosync-0.3.0

@@ -1,20 +1,21 @@
 = BlavoSync
 
-== DEPENDENCIES
+== Dependencies
 
 * Capistrano2 (http://github.com/jamis/capistrano)
 
 == Requirements
 
 * A reason to have your production stuff on your development machine.
 * A production server running mysql and sshd.
 * A valid $RAILS_ROOT/config/database.yml file with entries for both production and development.
 * The latest capistrano2 and a valid $RAILS_ROOT/config/deploy.rb file with either a :domain or :rsync domain entry.
 * The blavosync rubygem, available at http://gemcutter.org (sudo gem install blavosync).
-* Hopefully you already have a nice little app running somewhere that has some decent data and assets. In your $RAILS_ROOT/config/deploy.rb file add this line to the top:
 
+Hopefully you already have a nice little app running somewhere that has some decent data and assets. In your $RAILS_ROOT/config/deploy.rb file add this line to the top:
+
     require "blavosync/recipes"
 
 In addition, ensure that you have an entry either for :domain or :rsync_domain like so:
 
     set :domain, "my.awesomedomain.com"
@@ -25,36 +26,37 @@
 
 This covers the basic requirements, on to usage.  As long as your $RAILS_ROOT/config/deploy.rb file is working, the only action you need to take is to run the following on your local machine.
 
     cap local:sync
 
-This will dump the production database and load it into your local mysql database, defined in your $RAILS_ROOT/config/database.yml, and then rsync anything in your $RAILS_ROOT/shared/system directory on production into your $RAILS_ROOT/tmp directory in a new system directory. Once this is done, the $RAILS_ROOT/tmp/system directory will be symlinked into $RAILS_ROOT/public/system.
+This will dump the production database and load it into your local mysql database, defined in your $RAILS\_ROOT/config/database.yml, and then rsync anything in your $RAILS\_ROOT/shared/system directory on production into your $RAILS\_ROOT/tmp directory in a new system directory. Once this is done, the $RAILS\_ROOT/tmp/system directory will be symlinked into $RAILS_ROOT/public/system.
 
 There are some considerations you should take before using this tool, such as do you have enough disk space or bandwidth to pull down all the assets. You may already have a $RAILS_ROOT/public/system directory full of assets, in which case if you want to keep those you should back them up somewhere and delete the system directory, otherwise the symlink may not work.
 
 If you are on OSX you may need to enable FollowSymLinks in your virtualhost entry for these assets to be served by apache.
 
-== USAGE
+== Usage
 
-adds the following tasks to projects using capistrano
+    sudo gem install blavosync -s http://gemcutter.org
 
+Adds the following tasks to projects using capistrano.
+
 === cap local:sync
+Wrapper for *local:sync_db* and *local:sync\_content*.
 
-Wrapper for local:sync_db and local:sync\_content
-$> cap local:sync
-
 === cap local:rsync
+Wrapper for *local:rsync_content* and *local:rsync\_restore\_content*.
 
-Wrapper for local:rsync_content and local:rsync\_restore\_content
-$> cap local:sync_content
-
 === cap local:sync_db
+Wrapper for *local:backup_db* and *local:restore\_db*.
 
-Wrapper for local:backup_db and local:restore\_db.
-$> cap local:sync_db
+== Variables
 
+  set :content_directory, 'not_system_because_i_roll_non_standard_style'
 
-For subcommands try cap -T local
+For subcommands try 
+
+    cap -T local
 
 ==== Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.