From 0ce323b66695885ead5f42f85f260f7924083296 Mon Sep 17 00:00:00 2001
From: Tom Vaughan <tom@software6.net>
Date: Mon, 20 Aug 2012 16:42:11 -0700
Subject: [PATCH] initial attempt at documentation

---
 README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f1df2cd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+Middleman Delpoy -- Deploy a middleman built site over rsync.
+
+===
+
+## QUICK START
+
+Be sure that `rsync` is installed.
+
+### Step 1
+
+    gem install middleman-deploy
+
+### Step 2
+
+    middleman init example-site
+    cd example-site
+
+### Step 3
+
+Edit `Gemfile`, and add:
+
+    gem "middleman-deploy"
+
+Then run:
+
+    bundle install
+
+### Step 4
+
+#### These settings are required.
+
+Edit `config.ru`, and add:
+
+    activate :deploy do |deploy|
+      deploy.user = "tvaughan"
+      deploy.host = "www.example.com"
+      deploy.path = "/srv/www/site"
+    end
+
+Adjust these values accordingly.
+
+### Step 4.1
+
+#### These settings are optional.
+
+To use a particular SSH port (default is `22`), add:
+
+      deploy.port = 5309
+
+To pass the `--delete` option to rsync (default is `false`), add:
+
+      deploy.delete = true
+
+### Step 5
+
+    middleman build
+    middleman deploy