README.md in middleman-deploy-0.0.7 vs README.md in middleman-deploy-0.0.8

- old
+ new

@@ -56,45 +56,36 @@ Default is `false`. ### Step 4b - Git setup -First be sure that you have already placed your project under revision -control using git. - -For example, for the default values of remote="master" and -branch="gh-pages", the output of `git branch -a` should look like: - - gh-pages - * master - remotes/origin/HEAD -> origin/master - remotes/origin/gh-pages - remotes/origin/master - -This shows that "gh-pages" exists in the remote and local repos. There -needs to be at least one commit in "gh-pages" with which to start. - Edit `config.rb`, and add: activate :deploy do |deploy| deploy.method = :git end +By default this will deploy to the `gh-pages` branch on the `origin` +remote. The `build` directory will become a git repo. + #### These settings are optional. To use a particular remote, add: deploy.remote = "some-other-remote-name" -Default is `origin`. Run `git remote -v` to see a list of possible -remotes. +Default is `origin`. This can be a remote name or a git url. +If you use a remote name, you must first add it using `git remote +add`. Run `git remote -v` to see a list of possible remote names. If +you use a git url, it must end with '.git'. + To use a particular branch, add: deploy.branch = "some-other-branch-name" -Default is `gh-pages`. Run `git branch -a` to see a list of possible -branches. +Default is `gh-pages`. This branch will be created on the remote if it +doesn't already exist. ### Step 4c - FTP setup #### These settings are required.