Skip to content

docs: add plugins API #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fraxken merged 1 commit into from
Apr 23, 2023
Merged

docs: add plugins API #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 -->
Expand Down