Nanoscale Parts Manufacturing

    @form8ion/readme

    2.0.1 • Public • Published

    readme

    opinionated scaffolder for a project README

    Node CI Workflow Status

    Table of Contents

    Usage

    MIT license npm Try @form8ion/readme on RunKit node

    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

    PRs Welcome Commitizen friendly Conventional Commits semantic-release Renovate

    Dependencies

    $ nvm install
    $ npm install

    Verification

    $ npm test

    Keywords

    none

    Install

    npm i @form8ion/readme

    DownloadsWeekly Downloads

    1,647

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    21.4 kB

    Total Files

    8

    Last publish

    Collaborators

    • travi
    • form8ion-bot