Skip to content

Commit 7a17cc6

Browse files
committed
update docs with minor detail
1 parent 765d845 commit 7a17cc6

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ As mentioned above, plugins need to live under `./.github/scanner-plugins`. For
179179
- Each seperate plugin should live in a separate folder under `./.github/scanner-plugins`. So `./.github/scanner-plugins/plugin-1` would be 1 plugin loaded by the scanner
180180
- Each plugin should have one `index.js` file inside its folder
181181
- The `index.js` file must export a `name` field. This is the name used to pass to the `scans` input. So the following: `scans: ['my-custom-plugin']` would cause the scanner to only run that plugin
182-
- The `index.js` file must export a default function. This is the function that the scanner uses to run the plugin.
182+
- The `index.js` file must export a default function. This is the function that the scanner uses to run the plugin. This can be an async function.
183183

184184
### Things To Lookout For
185185

0 commit comments

Comments
 (0)