Skip to content

Commit 31d767a

Browse files
committed
update README with changes to require / include for DSL
1 parent d404c75 commit 31d767a

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

EXAMPLES.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,12 +279,14 @@ known test cases, it works. The key thing is that `if` is not mapped to
279279

280280
Into the `Rakefile` simply put something like:
281281

282-
require 'sshkit/dsl'
282+
require 'sshkit'
283283

284284
SSHKit.config.command_map[:rake] = "./bin/rake"
285285

286286
desc "Deploy the site, pulls from Git, migrate the db and precompile assets, then restart Passenger."
287287
task :deploy do
288+
include SSHKit::DSL
289+
288290
on "example.com" do |host|
289291
within "/opt/sites/example.com" do
290292
execute :git, :pull

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ more servers.
1111
The typical use-case looks something like this:
1212

1313
```ruby
14-
require 'sshkit/dsl'
14+
require 'sshkit'
15+
include SSHKit::DSL
1516

1617
on %w{1.example.com 2.example.com}, in: :sequence, wait: 5 do
1718
within "/opt/sites/example.com" do

0 commit comments

Comments
 (0)