Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

## Requirements

- [Node.js](https://nodejs.org/en/) v16 or higher
- [Node.js](https://nodejs.org/en/) v18 or higher

## Getting Started

Expand All @@ -44,9 +44,10 @@ const data = await scorecard.result("NodeSecure/scanner");
console.log(data);
```

You can provide either `**GitHub** (`github.com`), **GitHub Enterprise Server (GHES)** (`github.corp.com`) or **GitLab** (`gitlab.com`) platform with the options payload:
You can provide either **GitHub** (`github.com`), **GitHub Enterprise Server (GHES)** (`github.corp.com`) or **GitLab** (`gitlab.com`) platform with the options payload:

const data = await scorecard.result("NodeSecure/scanner", {
```ts
const data = await scorecard.result("gitlab-org/gitlab-ui", {
platform: "gitlab.com", // default to github.com
});
console.log(data);
Expand Down
3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
"exports": "./dist/index.js",
"types": "./dist/index.d.ts",
"type": "module",
"engines": {
"node": ">=18"
},
"scripts": {
"build": "tsc",
"prepublishOnly": "npm run build",
Expand Down