Skip to content

Commit

Permalink
fix docs, bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
pstadler committed Feb 18, 2014
1 parent eaa40ad commit e39e25e
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,8 @@ is formatted correctly within the current context.
transport.log('Copying files to remote hosts');
```

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

Prompt for user input.

```javascript
Expand All @@ -386,7 +388,7 @@ if(input.indexOf('yes') === -1) {
local.abort('user canceled flight');
}

// prompt for password (hide input UNIX style)
// prompt for password (with UNIX-style hidden input)
var password = local.prompt('Enter your password:', { hidden: true });
```

Expand Down
8 changes: 4 additions & 4 deletions lib/transport/transport.js
Original file line number Diff line number Diff line change
Expand Up @@ -187,14 +187,14 @@ Transport.prototype = {
* local.abort('user canceled flight');
* }
*
* // prompt for password (hide input UNIX style)
* // prompt for password (with UNIX-style hidden input)
* var password = local.prompt('Enter your password:', { hidden: true });
* ```
*
* @method(query[, options])
* @method prompt(message[, options])
* @return input
*/
prompt: function(query, options) {
prompt: function(message, options) {
options = options || {};
var fiber = Fiber.current;

Expand All @@ -204,7 +204,7 @@ Transport.prototype = {

prompt.get([{
name: 'input',
description: ' ' + query.white,
description: ' ' + message.white,
hidden: options.hidden || false,
required: options.required || false
}], function(err, result) {
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "flightplan",
"description": "Run a sequence of commands against local and remote hosts",
"version": "0.1.4",
"version": "0.1.5",
"author": "Patrick Stadler <[email protected]>",
"keywords": [
"deploy",
Expand Down Expand Up @@ -38,7 +38,7 @@
},
"devDependencies": {
"gulp": "~3.5.2",
"gulp-jshint": "~1.4.0",
"gulp-jshint": "~1.4.2",
"jshint-stylish": "~0.1.5",
"markdox": "~0.1.2"
},
Expand Down

0 comments on commit e39e25e

Please sign in to comment.