Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme with command line options #333

Merged
merged 1 commit into from May 29, 2020
Merged

Update readme with command line options #333

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions readme.md
View file
Open in desktop
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