readme

opinionated scaffolder for a project README

Table of Contents

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

Usage

Installation

$ npm install @form8ion/readme --save-prod

Example

Import

import {lift, scaffold} from '@form8ion/readme';

Execute

(async () => {
  await scaffold({projectRoot: process.cwd(), projectName: 'foo', description: 'Short description of the project'});

  await lift({projectRoot: process.cwd(), results: {badges: {}, documentation: {}}});
})();

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test