Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pstadler committed Feb 24, 2014
1 parent 9a88c75 commit 1ea3c48
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ plan.local(function(local) {
// run commands on remote hosts (destinations)
plan.remote(function(remote) {
remote.log('Move folder to web root');
remote.sudo('cp -R /tmp/' + tmpDir + ' ~/pstadler-sh', {user: 'www'});
remote.sudo('cp -R /tmp/' + tmpDir + ' ~', {user: 'www'});
remote.rm('-rf /tmp/' + tmpDir);

remote.log('Install dependencies');
Expand Down Expand Up @@ -151,7 +151,7 @@ plan.local(function(transport) {});
// ...
```

### flightplan.briefing(config) → this
### flightplan.briefing(config) → this

Configure the flightplan's destinations with `briefing()`. Without a
proper briefing you can't do remote flights which require at
Expand Down Expand Up @@ -194,7 +194,7 @@ the `-u|--username` option:
fly production --username=admin
```

### flightplan.local(fn) → this
### flightplan.local(fn) → this

Calling this method registers a local flight. Local flights are
executed on your local host. When `fn` gets called a `Transport` object
Expand All @@ -206,7 +206,7 @@ plan.local(function(local) {
});
```

### flightplan.remote(fn) → this
### flightplan.remote(fn) → this

Calling this method registers a remote flight. Remote
flights are executed on the current destination's remote hosts defined
Expand All @@ -219,20 +219,20 @@ plan.remote(function(remote) {
});
```

### flightplan.success(fn) → this
### flightplan.success(fn) → this

`fn()` is called after the flightplan (and therefore all flights)
succeeded.

### flightplan.disaster(fn) → this
### flightplan.disaster(fn) → this

`fn()` is called after the flightplan was aborted.

### flightplan.debriefing(fn)

`fn()` is called at the very end of the flightplan's execution.

### flightplan.isAborted() → Boolean
### flightplan.isAborted() → Boolean

Whether the flightplan is aborted or not.

Expand Down Expand Up @@ -324,7 +324,7 @@ transport.sudo('echo Hello world', {user: 'www'});
transport.sudo('echo Hello world', {user: 'www', silent: true, failsafe: true});
```

### transport.transfer(files, remoteDir[, options]) → [results]
### transport.transfer(files, remoteDir[, options]) → [results]

Copy a list of files to the current destination's remote host(s) using
`rsync` with the SSH protocol. File transfers are executed in parallel.
Expand Down Expand Up @@ -374,7 +374,7 @@ is formatted correctly within the current context.
transport.log('Copying files to remote hosts');
```

### transport.prompt(message[, options]) → input
### transport.prompt(message[, options]) → input

Prompt for user input.

Expand Down

0 comments on commit 1ea3c48

Please sign in to comment.