updated readme
This commit is contained in:
parent
a2dbd3f1b9
commit
ce63e87fd0
1 changed files with 13 additions and 0 deletions
13
readme.md
13
readme.md
|
@ -317,6 +317,19 @@ ghpages.publish(path.join(__dirname, 'build'), {
|
||||||
}, callback);
|
}, callback);
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### <a id="optionsdest">options.branchnameAsDest</a>
|
||||||
|
* type: `boolean`
|
||||||
|
* default: `false`
|
||||||
|
|
||||||
|
Use the current branch name as the path to the destination folder within the destination branch/repository. This option overrides the `dest` option.
|
||||||
|
|
||||||
|
Example use of the `dest` option:
|
||||||
|
|
||||||
|
```js
|
||||||
|
ghpages.publish(path.join(__dirname, 'build'), { branchnameAsDest: true }, callback);
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Command Line Utility
|
## Command Line Utility
|
||||||
|
|
||||||
Installing the package creates a `gh-pages` command line utility. Run `gh-pages --help` to see a list of supported options.
|
Installing the package creates a `gh-pages` command line utility. Run `gh-pages --help` to see a list of supported options.
|
||||||
|
|
Reference in a new issue