Skip to content

Commit

Permalink
Merge pull request #333 from Victoire44/cmd-doc
Browse files Browse the repository at this point in the history
Update readme with command line options
  • Loading branch information
tschaub authored May 29, 2020
2 parents 619d5b7 + f8f1f5d commit 289384d
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ The [minimatch](https://github.com/isaacs/minimatch) pattern or array of pattern
#### <a id="optionsbranch">options.branch</a>
* type: `string`
* default: `'gh-pages'`
* `-b | --branch <branch name>`

The name of the branch you'll be pushing to. The default uses GitHub's `gh-pages` branch, but this can be configured to push to any branch on any remote.

Expand Down Expand Up @@ -148,6 +149,7 @@ ghpages.publish('dist', {add: true}, callback);
#### <a id="optionsrepo">options.repo</a>
* type: `string`
* default: url for the origin remote of the current dir (assumes a git repository)
* `-r | --repo <repo url>`

By default, `gh-pages` assumes that the current working directory is a git repository, and that you want to push changes to the `origin` remote.

Expand Down

0 comments on commit 289384d

Please sign in to comment.