Skip to content

Commit be73d45

Browse files
docs: added path config info inside README
Refs: #159
1 parent 5e61e81 commit be73d45

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,17 +52,18 @@ Plugin uses no environment variables, but has a lot of configuration options
5252

5353
### Options
5454

55-
| Options | Description | Default |
56-
|-------------------|------------------------------------------------------------|-----------------------------------------------------------------------|
57-
| `type` | Type of the package to create. Can be `plugin` or `theme` | None. **You must set this explicitly** |
58-
| `slug` | Package slug. | None. **You must set this explicitly** |
59-
| `withAssets` | Does the package have assets (screenshots, banners, logo) | `false` |
60-
| `withReadme` | Does the package have a readme.txt file | `false` |
61-
| `withVersionFile` | Do we need to create a file with the next release version | `true` |
62-
| `releasePath` | Base path for all of the release files | `/tmp/wp-release` |
63-
| `versionFiles` | Array of additional files containing the package version. | `[]` |
64-
| `include` | Files to include in the package zip file. | `**/*` |
65-
| `exclude` | Files to exclude from the package zip file | List of files and folders defined in [constants.ts](lib/constants.ts) |
55+
| Options | Description | Default |
56+
|-------------------|-----------------------------------------------------------|-----------------------------------------------------------------------|
57+
| `type` | Type of the package to create. Can be `plugin` or `theme` | None. **You must set this explicitly** |
58+
| `slug` | Package slug. | None. **You must set this explicitly** |
59+
| `path` | The path of root folder that contains plugin or theme | `./` |
60+
| `withAssets` | Does the package have assets (screenshots, banners, logo) | `false` |
61+
| `withReadme` | Does the package have a readme.txt file | `false` |
62+
| `withVersionFile` | Do we need to create a file with the next release version | `true` |
63+
| `releasePath` | Base path for all of the release files | `/tmp/wp-release` |
64+
| `versionFiles` | Array of additional files containing the package version. | `[]` |
65+
| `include` | Files to include in the package zip file. | `**/*` |
66+
| `exclude` | Files to exclude from the package zip file | List of files and folders defined in [constants.ts](lib/constants.ts) |
6667

6768
### Versioning
6869

0 commit comments

Comments
 (0)