README.md in middleman-deploy-0.0.3 vs README.md in middleman-deploy-0.0.4
- old
+ new
@@ -4,11 +4,11 @@
===
## QUICK START
-Be sure that `rsync` is installed.
+If deploying through `rsync`, be sure it is installed.
### Step 1
gem install middleman-deploy
@@ -25,26 +25,25 @@
Then run:
bundle install
-### Step 4
+### Step 4a - Rsync setup
#### These settings are required.
Edit `config.rb`, and add:
activate :deploy do |deploy|
- deploy.user = "tvaughan"
- deploy.host = "www.example.com"
- deploy.path = "/srv/www/site"
+ deploy.method = :rsync
+ 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, add:
deploy.port = 5309
@@ -54,9 +53,20 @@
To remove orphaned files or directories on the remote host, add:
deploy.clean = true
Default is `false`.
+
+### Step 4b - Github Pages setup
+
+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.
### Step 5
middleman build
middleman deploy