Updated documentation
This commit is contained in:
parent
bf8ce71a49
commit
134420026b
1 changed files with 17 additions and 7 deletions
18
README.md
18
README.md
|
@ -6,7 +6,7 @@ Middleman Delpoy -- Deploy a [middleman](http://middlemanapp.com/) built site ov
|
|||
|
||||
## QUICK START
|
||||
|
||||
Be sure that `rsync` is installed.
|
||||
If deploying through `rsync`, be sure it is installed.
|
||||
|
||||
### Step 1
|
||||
|
||||
|
@ -27,13 +27,14 @@ Then run:
|
|||
|
||||
bundle install
|
||||
|
||||
### Step 4
|
||||
### Step 4a - Rsync setup
|
||||
|
||||
#### These settings are required.
|
||||
|
||||
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"
|
||||
|
@ -41,8 +42,6 @@ Edit `config.rb`, and add:
|
|||
|
||||
Adjust these values accordingly.
|
||||
|
||||
### Step 4.1
|
||||
|
||||
#### These settings are optional.
|
||||
|
||||
To use a particular SSH port, add:
|
||||
|
@ -57,6 +56,17 @@ To remove orphaned files or directories on the remote host, add:
|
|||
|
||||
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
|
||||
|
|
Loading…
Reference in a new issue