README.md in middleman-deploy-0.0.4 vs README.md in middleman-deploy-0.0.5
- old
+ new
@@ -1,6 +1,6 @@
-Middleman Delpoy -- Deploy a [middleman](http://middlemanapp.com/) built site over rsync.
+Middleman Delpoy -- Deploy a [middleman](http://middlemanapp.com/) built site over rsync or to github pages.
[![Build Status](https://secure.travis-ci.org/tvaughan/middleman-deploy.png)](http://travis-ci.org/tvaughan/middleman-deploy)
===
@@ -19,11 +19,11 @@
### Step 3
Edit `Gemfile`, and add:
- gem "middleman-deploy"
+ gem "middleman-deploy", "~>0.0.1"
Then run:
bundle install
@@ -33,13 +33,13 @@
Edit `config.rb`, and add:
activate :deploy do |deploy|
deploy.method = :rsync
- deploy.user = "tvaughan"
- deploy.host = "www.example.com"
- deploy.path = "/srv/www/site"
+ deploy.user = "tvaughan"
+ deploy.host = "www.example.com"
+ deploy.path = "/srv/www/site"
end
Adjust these values accordingly.
#### These settings are optional.
@@ -54,11 +54,11 @@
deploy.clean = true
Default is `false`.
-### Step 4b - Github Pages setup
+### Step 4b - GitHub Pages setup
Edit `config.rb`, and add:
activate :deploy do |deploy|
deploy.method = :git
@@ -67,10 +67,10 @@
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 build [--clean]
middleman deploy
### NOTES
Inspired by the rsync task in [Octopress](https://github.com/imathis/octopress).