From f8f1f5d4d6cfca5cedbb3f824330c29b502e6a70 Mon Sep 17 00:00:00 2001 From: Victoire Date: Sun, 9 Feb 2020 14:21:57 -0800 Subject: [PATCH] Update readme with command line options --- readme.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/readme.md b/readme.md index 1b66863f..34a297ad 100644 --- a/readme.md +++ b/readme.md @@ -77,6 +77,7 @@ The [minimatch](https://github.com/isaacs/minimatch) pattern or array of pattern #### options.branch * type: `string` * default: `'gh-pages'` + * `-b | --branch ` 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. @@ -148,6 +149,7 @@ ghpages.publish('dist', {add: true}, callback); #### options.repo * type: `string` * default: url for the origin remote of the current dir (assumes a git repository) + * `-r | --repo ` 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.