Permalink
Browse files

Updated readme

  • Loading branch information...
1 parent 2c33ca2 commit 8e055a18a6091b371be5d571c642122ca43e7721 @Zequez committed Jan 20, 2014
Showing with 22 additions and 0 deletions.
  1. +22 −0 readme.md
View
@@ -64,6 +64,28 @@ The remote path to upload too.
Doesn't have to exist as [jsftp-mkdirp](https://github.com/sindresorhus/jsftp-mkdirp) is used.
+#### options.localPath
+
+Type: `String`
+Default `'.'`
+
+The local path to upload from.
+This is useful for example when you use
+
+```javascript
+gulp.src('_public/js/*').pipe({remotePath: '/www/some/path'});
+```
+
+And you want the contents of `_public/js` to be uploaded to
+`/www/some/path`, but not `_public/js` itself. Then you just set
+`localPath` to `_public/js` and you are done.
+
+#### options.logFiles
+
+Type: `Boolean`
+Default: `true`
+
+Logging of files as they are uploaded. If set to false, you will only see a message when all files finished.
## License

0 comments on commit 8e055a1

Please sign in to comment.