diff --git a/readme.md b/readme.md
index 977baf5c..aefdd286 100644
--- a/readme.md
+++ b/readme.md
@@ -37,6 +37,7 @@ If a `gh-pages` branch already exists, it will be updated with all commits from
### `dir`
* type: `string`
+* `-d | --dist `
The base directory for all source files (those listed in the `src` config property).
@@ -70,6 +71,7 @@ The default options work for simple cases. The options described below let you
#### options.src
* type: `string|Array`
* default: `'**/*'`
+ * `-s | --src `
The [minimatch](https://github.com/isaacs/minimatch) pattern or array of patterns is used to select which files should be published.
@@ -97,6 +99,7 @@ ghpages.publish('dist', {
#### options.dest
* type: `string`
* default: `'.'`
+ * `-e | --dest `
The destination folder within the destination branch. By default, all files are published to the root of the repository.
@@ -115,6 +118,7 @@ ghpages.publish('dist', {
#### options.dotfiles
* type: `boolean`
* default: `false`
+ * `-t | --dotfile `
Include dotfiles. By default, files starting with `.` are ignored unless they are explicitly provided in the `src` array. If you want to also include dotfiles that otherwise match your `src` patterns, set `dotfiles: true` in your options.
@@ -132,6 +136,7 @@ ghpages.publish('dist', {dotfiles: true}, callback);
#### options.add
* type: `boolean`
* default: `false`
+ * `-a | --add `
Only add, and never remove existing files. By default, existing files in the target branch are removed before adding the ones from your `src` config. If you want the task to add new `src` files but leave existing ones untouched, set `add: true` in your options.
@@ -172,6 +177,7 @@ ghpages.publish('dist', {
#### options.remote
* type: `string`
* default: `'origin'`
+ * `-o | --remote `
The name of the remote you'll be pushing to. The default is your `'origin'` remote, but this can be configured to push to any remote.
@@ -190,6 +196,7 @@ ghpages.publish('dist', {
#### options.tag
* type: `string`
* default: `''`
+ * `-g | --tag `
Create a tag after committing changes on the target branch. By default, no tag is created. To create a tag, provide the tag name as the option value.
@@ -197,6 +204,7 @@ Create a tag after committing changes on the target branch. By default, no tag
#### options.message
* type: `string`
* default: `'Updates'`
+ * `-m | --message `
The commit message for all commits.
@@ -215,6 +223,7 @@ ghpages.publish('dist', {
#### options.user
* type: `Object`
* default: `null`
+ * `-u | --user "Your Name "`
If you are running the `gh-pages` task in a repository without a `user.name` or `user.email` git config properties (or on a machine without these global config properties), you must provide user info before git allows you to commit. The `options.user` object accepts `name` and `email` string values to identify the committer.
@@ -229,9 +238,10 @@ ghpages.publish('dist', {
}, callback);
```
-#### options.remove
+#### options.remove
* type: `string`
* default: `'.'`
+ * `-v | --remove `
Removes files that match the given pattern (Ignored if used together with
`--add`). By default, `gh-pages` removes everything inside the target branch
@@ -249,6 +259,7 @@ ghpages.publish('dist', {
#### options.push
* type: `boolean`
* default: `true`
+ * `-n | --no-push `
Push branch to remote. To commit only (with no push) set to `false`.
@@ -262,6 +273,7 @@ ghpages.publish('dist', {push: false}, callback);
#### options.history
* type: `boolean`
* default: `true`
+ * `-f | --no-history `
Push force new commit without parent history.
@@ -275,6 +287,7 @@ ghpages.publish('dist', {history: false}, callback);
#### options.silent
* type: `boolean`
* default: `false`
+ * `-x | --silent `
Avoid showing repository URLs or other information in errors.
@@ -294,6 +307,7 @@ ghpages.publish('dist', {
#### options.beforeAdd
* type: `function`
* default: `null`
+ * `--before-add `
Custom callback that is executed right before `git add`.
@@ -323,6 +337,7 @@ ghpages.publish('dist', {
#### options.git
* type: `string`
* default: `'git'`
+ * `--git `
Your `git` executable.