README.md in middleman-deploy-0.0.5 vs README.md in middleman-deploy-0.0.6
- old
+ new
@@ -1,15 +1,13 @@
-Middleman Delpoy -- Deploy a [middleman](http://middlemanapp.com/) built site over rsync or to github pages.
+Middleman Delpoy -- Deploy a [middleman](http://middlemanapp.com/) built site over rsync or via git (e.g. gh-pages on github).
[![Build Status](https://secure.travis-ci.org/tvaughan/middleman-deploy.png)](http://travis-ci.org/tvaughan/middleman-deploy)
===
## QUICK START
-If deploying through `rsync`, be sure it is installed.
-
### Step 1
gem install middleman-deploy
### Step 2
@@ -27,10 +25,12 @@
bundle install
### Step 4a - Rsync setup
+First be sure that `rsync` is installed.
+
#### These settings are required.
Edit `config.rb`, and add:
activate :deploy do |deploy|
@@ -54,24 +54,52 @@
deploy.clean = true
Default is `false`.
-### Step 4b - GitHub Pages setup
+### 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
-The git deploy method assumes your project is in a repository with
-github set up as `origin` and a working `gh-pages` branch already in place.
+#### 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.
+
+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.
+
### Step 5
middleman build [--clean]
- middleman deploy
+ middleman deploy [--clean]
### NOTES
Inspired by the rsync task in [Octopress](https://github.com/imathis/octopress).