docs: add plugins API (#23)

dashlog · Apr 23, 2023 · 01f9ed4 · 01f9ed4
1 parent aa1dc34
commit 01f9ed4
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -27,6 +27,23 @@ const { logo, projects } = await fetchOrgMetadata("NodeSecure");
 console.log({ logo, projects });
 ```
 
+### Available plugins
+
+- <kbd>scorecard</kbd> for OSSF Scorecard
+- <kbd>nodesecure</kbd> to include NodeSecure scanner `verify` method.
+
+Plugins need to be requested while fetching organization metadata:
+```js
+const { projects } = await fetchOrgMetadata("NodeSecure", {
+  plugins: ["scorecard", "nodesecure"]
+});
+
+for (const { plugins } of projects) {
+  console.log(plugins.scorecard);
+  console.log(plugins.nodesecure);
+}
+```
+
 ## Contributors ✨
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->