README.rdoc in versionator-0.0.4 vs README.rdoc in versionator-0.1.0

@@ -10,10 +10,26 @@
 
 Install with bundler
 
     $ bundle install
 
+== Github
+
+Versionator pushes the git tag and VERSION file to your project's github repository (origin master) each time you run the rake tasks.  It is recommended that you commit all code and push to master before bumping your version.  
+
+Order of execution for the rake tasks:
+
+1. Bump the version locally based on the version in /your_app/VERSION
+2. Write the new version to /your_app/VERSION
+3. git checkout master
+4. git pull
+5. git tag new version
+6. git commit (This will commit your new VERSION file)
+7. git push (new tag and VERSION file)
+
+TODO: Currently there is no error checking in place for each of these automated steps.  The rake tasks should be changed to stop execution if there is code to be committed or new code from the pull
+
 == Usage
 
 There are 3 rake tasks for each version category.  If the VERSION file does not exist in the app root directory, the rake task will create it automatically
 
 Bump a patch version, git tag and push to github
@@ -39,10 +55,10 @@
 * Fork the project
 * Start a feature/bugfix branch
 * Commit and push until you are happy with your contribution
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-*** Tests are located in a separate repository, since their needs to be a project to tag against.  Here is the test repo: [e-mail]:johnmcaliley/test_app.git
+*** Tests are located in a separate repository, since their needs to be a project to tag against.  Here is the test repo: https://github.com/johnmcaliley/test_app
 
 == Copyright
 
 Copyright (c) 2011 John McAliley. See LICENSE.txt for
 further details.