Update readme and version

b00ste · Jul 10, 2023 · bfff070 · bfff070
1 parent ab070cb
commit bfff070
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -122,8 +122,8 @@ Here are all the configuration parameters that are currently available, but as s
 | Parameter           | Description                                                                                                                                                                                                  | Default value     |
 | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------- |
 | `runOnCompile`      | True if the plugin should generate the documentation on every compilation                                                                                                                                    | `true`            |
-| `include`           | List of all the contract / interface / library relative paths to include in the documentation generation. An empty array will generate documentation for everything                                          | `[]`              |
-| `exclude`           | List of all the contract / interface / library relative paths to exclude from the documentation generation                                                                                                   | `[]`              |
+| `include`           | List of all the contract / interface / library relative paths or names to include in the documentation generation. An empty array will generate documentation for everything                                 | `[]`              |
+| `exclude`           | List of all the contract / interface / library relative paths or names to exclude from the documentation generation                                                                                          | `[]`              |
 | `libraries`         | Used to separate the generated docs into two folders: 1. _contracts_ & 2. _libraries_. Add the relative path of the library to the array if you want to separate it to the libraries folder.                 | `[]`              |
 | `outputDir`         | Output directory of the documentation                                                                                                                                                                        | `docs`            |
 | `templatePath`      | Path to the documentation template                                                                                                                                                                           | `./template.sqrl` |

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@b00ste/hardhat-dodoc",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "Zero-config Hardhat plugin to generate documentation for all your Solidity contracts",
   "repository": "github:b00ste/primitive-dodoc",
   "author": "Primitive",