README.md

ossf-scorecard

form8ion plugin for configuring the OpenSSF Scorecard for a project

Table of Contents

• Usage
  • Installation
  • Example
    • Import
    • Execute
• Contributing
  • Dependencies
  • Verification

Usage

Installation

$ npm install @form8ion/ossf-scorecard --save-prod

Example

Import

import {scaffold} from '@form8ion/ossf-scorecard';

Execute

(async () => {
  await scaffold({projectRoot: process.cwd(), vcs: {owner: 'foo', name: 'bar', host: 'github'}});
})();

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test