README.md

github-core

core package to support form8ion plugins that interact with GitHub

Table of Contents

• Usage
  • Installation
  • Example
• Contributing
  • Dependencies
  • Verification

Usage

Installation

$ npm install @form8ion/github-core

Example

import {sourceHostedOnGitHub, octokit} from '@form8ion/github-core';

await sourceHostedOnGitHub({projectRoot: process.cwd()});

octokit.getNetrcAuthenticatedInstance({
  logger: {
    info: message => console.error(message),
    warn: message => console.error(message),
    error: message => console.error(message)
  }
});

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test