@form8ion/base

base

form8ion plugin for management of an organization's `.github` repository

Table of Contents

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

Features

• Manages the account-level config for the repository-settings app

Usage

Installation

$ npm install @form8ion/base --save

Example

Import

import {scaffold} from '@form8ion/base';

Execute

(async () => {
  await scaffold({projectRoot: process.cwd()});
})();

API

scaffold

Scaffolder for configuring a .github repository for a GitHub account

Accepts a single options object as an argument, containing:

projectRoot string (required)

path to the root of the project

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test