diff --git a/README.md b/README.md index 35750406..ed7e8e49 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ # NodeSecure Scanner -![version](https://img.shields.io/badge/dynamic/json.svg?url=https://raw.githubusercontent.com/NodeSecure/scanner/master/package.json&query=$.version&label=Version) -[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/NodeSecure/scanner/commit-activity) + +![version](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&url=https://raw.githubusercontent.com/NodeSecure/scanner/master/package.json&query=$.version&label=Version) +[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg?style=for-the-badge)](https://github.com/NodeSecure/scanner/commit-activity) [![OpenSSF -Scorecard](https://api.securityscorecards.dev/projects/github.com/NodeSecure/scanner/badge)](https://api.securityscorecards.dev/projects/github.com/NodeSecure/scanner) -[![mit](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/NodeSecure/scanner/blob/master/LICENSE) -![build](https://img.shields.io/github/actions/workflow/status/NodeSecure/scanner/node.js.yml) +Scorecard](https://api.securityscorecards.dev/projects/github.com/NodeSecure/scanner/badge?style=for-the-badge)](https://api.securityscorecards.dev/projects/github.com/NodeSecure/scanner) +[![mit](https://img.shields.io/github/license/Naereen/StrapDown.js.svg?style=for-the-badge)](https://github.com/NodeSecure/scanner/blob/master/LICENSE) +![build](https://img.shields.io/github/actions/workflow/status/NodeSecure/scanner/node.js.yml?style=for-the-badge) ⚡️ Run a static analysis of your module's dependencies. @@ -49,8 +50,14 @@ await Promise.allSettled(promises); See `types/api.d.ts` for a complete TypeScript definition. ```ts -function cwd(location: string, options?: Scanner.Options): Promise; -function from(packageName: string, options?: Omit): Promise; +function cwd( + location: string, + options?: Scanner.Options +): Promise; +function from( + packageName: string, + options?: Omit +): Promise; function verify(packageName?: string | null): Promise; ``` @@ -71,7 +78,9 @@ interface Options { ## Contributors ✨ + [![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](#contributors-) + Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): @@ -103,4 +112,5 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d ## License + MIT diff --git a/SECURITY.md b/SECURITY.md index 04723424..4ff1961a 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,4 +1,5 @@ # Reporting Security Issues -To report a security issue, please email `gentilhomme.thomas@gmail.com` with a description of the issue, the steps you took to create the issue, affected versions, and, if known, mitigations for the issue. -Our vulnerability management team will respond within one week to your email. If the issue is confirmed as a vulnerability, we will open a Security Advisory and acknowledge your contributions as part of it. This project follows a 90 day disclosure timeline. +To report a security issue, please [publish a private security advisory](https://github.com/NodeSecure/scanner/security/advisories) with a description of the issue, the steps you took to create the issue, affected versions, and, if known, mitigations for the issue. + +Our vulnerability management team will respond within one week. If the issue is confirmed as a vulnerability, we will open a Security Advisory and acknowledge your contributions as part of it. This project follows a 90 day disclosure timeline.