diff --git a/readme.md b/readme.md index cf824958..1b66863f 100644 --- a/readme.md +++ b/readme.md @@ -227,6 +227,22 @@ ghpages.publish('dist', { }, callback); ``` +#### options.remove + * type: `string` + * default: `'.'` + +Removes files that match the given pattern (Ignored if used together with +`--add`). By default, `gh-pages` removes everything inside the target branch +auto-generated directory before copying the new files from `dir`. + +Example use of the `remove` option: + +```js +ghpages.publish('dist', { + remove: "*.json" +}, callback); +``` + #### options.push * type: `boolean` @@ -338,7 +354,7 @@ Note that this plugin requires Git 1.9 or higher (because it uses the `--exit-co ``` When processing `gh-pages` module generate file in`.cache/` and if stuck some reason like wrong password -it will not automatically cleanup +it will not automatically cleanup Run `~node_modules/gh-pages/bin/gh-pages-clean` or remove `~node_modules/gh-pages/.cache`