doc: update README.md by adding keepFileStructure option

b00ste · Jan 9, 2022 · 7db83c7 · 7db83c7
1 parent e8ff6ef
commit 7db83c7
Showing 1 changed file with 9 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -100,14 +100,15 @@ export default config;
 
 Here are all the configuration parameters that are currently available, but as said above, all of them are entirely optional:
 
-| 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 names to include in the documentation generation. An empty array will generate documentation for everything | `[]` |
-| `exclude` | List of all the contract / interface / library names to exclude from the documentation generation | `[]` |
-| `outputDir` | Output directory of the documentation | `docs` |
-| `templatePath` | Path to the documentation template | `./template.sqrl`|
-| `testMode` | Test mode generating additional JSON files used for debugging | `false` |
+| 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 names to include in the documentation generation. An empty array will generate documentation for everything | `[]`              |
+| `exclude`           | List of all the contract / interface / library names to exclude from the documentation generation                                                          | `[]`              |
+| `outputDir`         | Output directory of the documentation                                                                                                                      | `docs`            |
+| `templatePath`      | Path to the documentation template                                                                                                                         | `./template.sqrl` |
+| `testMode`          | Test mode generating additional JSON files used for debugging                                                                                              | `false`           |
+| `keepFileStructure` | True if you want to preserve your contracts file structure                                                                                                 | `true`            |
 
 ## 💅 Customize