README.md in middleman-deploy-0.0.12 vs README.md in middleman-deploy-0.1.0

@@ -1,37 +1,32 @@
-Middleman Deploy - Deploy a [middleman](http://middlemanapp.com/) built site over rsync, git (e.g. gh-pages on github) or via ftp.
+Middleman Deploy - Deploy a [middleman](http://middlemanapp.com/)
+built site over rsync, ftp, sftp, or 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
 
-## QUICK START
+## Step 1
 
-### Step 1
-
-    gem install middleman-deploy
-
-### Step 2
-
     middleman init example-site
     cd example-site
 
-### Step 3
+## Step 2
 
 Edit `Gemfile`, and add:
 
-    gem "middleman-deploy", "~> 0.0.12"
+    gem "middleman-deploy", ">= 0.1.0"
 
 Then run:
 
     bundle install
 
-### Step 4a - Rsync setup
+## Step 3a - Rsync setup
 
 First be sure that `rsync` is installed.
 
-#### These settings are required.
+**These settings are required.**
 
 Edit `config.rb`, and add:
 
     activate :deploy do |deploy|
       deploy.method = :rsync
@@ -40,11 +35,11 @@
       deploy.path = "/srv/www/site"
     end
 
 Adjust these values accordingly.
 
-#### These settings are optional.
+**These settings are optional.**
 
 To use a particular SSH port, add:
 
       deploy.port = 5309
 
@@ -54,22 +49,26 @@
 
       deploy.clean = true
 
 Default is `false`.
 
-### Step 4b - Git setup
+## Step 3b - Git setup
 
+First be sure that `git` is installed.
+
+**These settings are required.**
+
 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.
+**These settings are optional.**
 
 To use a particular remote, add:
 
       deploy.remote = "some-other-remote-name"
 
@@ -84,13 +83,13 @@
       deploy.branch = "some-other-branch-name"
 
 Default is `gh-pages`. This branch will be created on the remote if it
 doesn't already exist.
 
-### Step 4c - FTP setup
+## Step 3c - FTP setup
 
-#### These settings are required.
+**These settings are required.**
 
 Edit `config.rb`, and add:
 
     activate :deploy do |deploy|
       deploy.method = :ftp
@@ -100,23 +99,51 @@
       deploy.path = "/srv/www/site"
     end
 
 Adjust these values accordingly.
 
-### Step 5
+## Step 3d - SFTP setup
 
+**These settings are required.**
+
+Edit `config.rb`, and add:
+
+    activate :deploy do |deploy|
+      deploy.method = :sftp
+      deploy.host = "sftp.example.com"
+      deploy.user = "tvaughan"
+      deploy.password = "secret"
+      deploy.path = "/srv/www/site"
+    end
+
+Adjust these values accordingly.
+
+## Step 4
+
     middleman build [--clean]
-    middleman deploy [--clean]
+    middleman deploy [--build-before]
 
-To automatically run middleman-deploy after `middleman build`, add:
+To run `middleman build` before `middleman deploy`, add:
 
-      deploy.after_build = true
+    deploy.build_before = true
 
 Default is `false`.
 
-Please note that if the `--clean` or `--no-clean` option is passed to
-`middleman build` it will not be passed to `middleman deploy`. For now
-only the value of `deploy.clean` in `config.rb` will be used.
+## BREAKING CHANGES
 
-### NOTES
+ * v0.1.0
 
-Inspired by the rsync task in [Octopress](https://github.com/imathis/octopress).
+   * Removed the `--clean` command-line option. This option only applied
+   to the rsync deploy method. The idea going forward is that
+   command-line options must apply to all deploy methods. Options that
+   are specific to a deploy method will only be available in
+   `config.rb`.
+
+   * Removed `deploy` from the `after_build` hook. This caused a
+   `deploy` to be run each time `build` was called. This workflow never
+   made sense. `deploy` was added to the `after_build` hook simply
+   because it was available.
+
+## NOTES
+
+Inspired by the rsync task in
+[Octopress](https://github.com/imathis/octopress).