From 0f0b5ca194306c3489565ef0855d794b3e044659 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robin=20R=C3=B6per?= Date: Mon, 12 Feb 2024 03:54:21 +0100 Subject: [PATCH] Replace exclude.js with include.js This replaces the use of example filename `exclude.js` in the README.md for the `--include` parameter with `include.js`, with the intention of improving readability. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 46d966e..b534def 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ Use these options after `vuepress-jsdoc`. | --version | -v | | Show current version | | --readme | -r | | Path to custom readme file | | --exclude | -e | | Pattern to exclude files/folders (Comma seperated) - \*.test.js,exclude.js [more information](https://github.com/micromatch/micromatch#ismatch) | -| --include | -e | | Pattern to include files/folders (Comma seperated) - \*.test.js,exclude.js [more information](https://github.com/micromatch/micromatch#ismatch) | +| --include | -e | | Pattern to include files/folders (Comma seperated) - \*.test.js,include.js [more information](https://github.com/micromatch/micromatch#ismatch) | | --rmPattern | -rm | | Pattern when removing files. You can ex- and include files. (glob pattern) | | --partials | -p | | jsdoc2markdown partial templates (overwrites default ones) | | --jsDocConfigPath | -c | | Path to [JsDoc Config](http://usejsdoc.org/about-configuring-jsdoc.html) (experimental) |