README.md in middleman-deploy-0.2.4 vs README.md in middleman-deploy-0.3.0
- old
+ new
@@ -1,62 +1,41 @@
-# middleman-deploy [](http://badge.fury.io/rb/middleman-deploy)
+# Middleman Deploy
-Deploys a [middleman](http://middlemanapp.com/) built site via **rsync**,
-**ftp**, **sftp**, or **git** (e.g. gh-pages on github).
+Deploy your [Middleman](http://middlemanapp.com/) build via **rsync**, **ftp**, **sftp**, or **git** (e.g. [gh-pages on github](https://help.github.com/articles/creating-project-pages-manually)).
-## Help!
-
-middleman-deploy needs a new maintainer. Please [create a GitHub issue](https://github.com/tvaughan/middleman-deploy/issues/new) if you're interested. Thanks!
-
## Installation
-Add this to the Gemfile of the repository of your middleman site:
-
```ruby
-gem "middleman-deploy"
+gem 'middleman-deploy', '~> 3.0'
```
-and run `bundle install`.
-
## Usage
```
$ middleman build [--clean]
$ middleman deploy [--build-before]
```
-To automatically run `middleman build` during `middleman deploy`, turn on the
-`build_before` option while activating the deploy extension:
-
-```ruby
-activate :deploy do |deploy|
- # ...
- deploy.build_before = true # default: false
-end
-```
-
## Possible Configurations
-Middleman-deploy can deploy a site via rsync, ftp, sftp, or git.
+Middleman-deploy can deploy a site via rsync, ftp, sftp, or git. Checkout [the wiki](https://github.com/tvaughan/middleman-deploy/wiki/_pages) for advanced set-up options.
-Checkout [the wiki](https://github.com/tvaughan/middleman-deploy/wiki/_pages) for advanced set-up options.
+### Rsync
-### rsync
-
Make sure that `rsync` is installed, and activate the extension by adding the
following to `config.rb`:
```ruby
activate :deploy do |deploy|
deploy.method = :rsync
- deploy.host = "www.example.com"
- deploy.path = "/srv/www/site"
+ deploy.host = 'www.example.com'
+ deploy.path = '/srv/www/site'
# Optional Settings
- # deploy.user = "tvaughan" # no default
+ # deploy.user = 'tvaughan' # no default
# deploy.port = 5309 # ssh port, default: 22
# deploy.clean = true # remove orphaned files on remote host, default: false
- # deploy.flags = "-rltgoDvzO --no-p --del" # add custom flags, default: -avz
+ # deploy.flags = '-rltgoDvzO --no-p --del' # add custom flags, default: -avz
end
```
### Git (e.g. GitHub Pages)
@@ -65,14 +44,14 @@
```ruby
activate :deploy do |deploy|
deploy.method = :git
# Optional Settings
- # deploy.remote = "custom-remote" # remote name or git url, default: origin
- # deploy.branch = "custom-branch" # default: gh-pages
+ # deploy.remote = 'custom-remote' # remote name or git url, default: origin
+ # deploy.branch = 'custom-branch' # default: gh-pages
# deploy.strategy = :submodule # commit strategy: can be :force_push or :submodule, default: :force_push
- # deploy.commit_message = "custom-message" # commit message (can be empty), default: Automated commit at `timestamp` by middleman-deploy `version`
+ # deploy.commit_message = 'custom-message' # commit message (can be empty), default: Automated commit at `timestamp` by middleman-deploy `version`
end
```
If you use a remote name, you must first add it using `git remote add`. Run
`git remote -v` to see a list of possible remote names. If you use a git url,
@@ -90,51 +69,63 @@
Activate the extension by adding the following to `config.rb`:
```ruby
activate :deploy do |deploy|
deploy.method = :ftp
- deploy.host = "ftp.example.com"
- deploy.path = "/srv/www/site"
- deploy.user = "tvaughan"
- deploy.password = "secret"
+ deploy.host = 'ftp.example.com'
+ deploy.path = '/srv/www/site'
+ deploy.user = 'tvaughan'
+ deploy.password = 'secret'
end
```
### SFTP
Activate the extension by adding the following to `config.rb`:
```ruby
activate :deploy do |deploy|
deploy.method = :sftp
- deploy.host = "sftp.example.com"
+ deploy.host = 'sftp.example.com'
deploy.port = 22
- deploy.path = "/srv/www/site"
+ deploy.path = '/srv/www/site'
# Optional Settings
- # deploy.user = "tvaughan" # no default
- # deploy.password = "secret" # no default
+ # deploy.user = 'tvaughan' # no default
+ # deploy.password = 'secret' # no default
end
```
+### Run Automatically
+
+To automatically run `middleman build` during `middleman deploy`, turn on the
+`build_before` option while activating the deploy extension:
+
+```ruby
+activate :deploy do |deploy|
+ # ...
+ deploy.build_before = true # default: false
+end
+```
+
### Multiple Environments
Deploy your site to more than one configuration using environment variables.
```ruby
# config.rb
case ENV['TARGET'].to_s.downcase
when 'production'
activate :deploy do |deploy|
deploy.method = :rsync
- deploy.host = "www.example.com"
- deploy.path = "/srv/www/production-site"
+ deploy.host = 'www.example.com'
+ deploy.path = '/srv/www/production-site'
end
else
activate :deploy do |deploy|
deploy.method = :rsync
- deploy.host = "staging.example.com"
- deploy.path = "/srv/www/staging-site"
+ deploy.host = 'staging.example.com'
+ deploy.path = '/srv/www/staging-site'
end
end
```
```ruby
@@ -168,15 +159,40 @@
- 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.
+## Badges
+
+[][gem]
+[][travis]
+[][codeclimate]
+[][codeclimate]
+[][gittip]
+
+## Supported Ruby Versions
+
+This library aims to support and is [tested against][travis] the following Ruby
+implementations:
+
+- Ruby 2.1.0
+- Ruby 2.0.0
+- Ruby 1.9.3
+- [JRuby][jruby]
+- [Rubinius][rubinius]
+
## Thanks!
-A **BIG** thanks to
-[everyone who has contributed](https://github.com/tvaughan/middleman-deploy/graphs/contributors)!
-Almost all pull requests are accepted.
+A **BIG** thanks to [everyone who has contributed](https://github.com/tvaughan/middleman-deploy/graphs/contributors)! Almost all pull requests are accepted.
-## Other
+# Credits
-Inspired by the rsync task in
-[Octopress](https://github.com/imathis/octopress).
+Inspiration:
+
+- The rsync task in [Octopress](https://github.com/imathis/octopress)
+
+[gem]: https://rubygems.org/gems/middleman-deploy
+[travis]: http://travis-ci.org/karlfreeman/middleman-deploy
+[codeclimate]: https://codeclimate.com/github/karlfreeman/middleman-deploy
+[gittip]: https://www.gittip.com/karlfreeman
+[jruby]: http://www.jruby.org
+[rubinius]: http://rubini.us