@form8ion/remark-readme

remark-readme

remark plugin for transforming the README for projects that follow form8ion conventions

Table of Contents

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

Usage

Installation

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

Example

Import

import fs from 'fs';
import remark from 'remark';
import updateReadme from '@form8ion/remark-readme';

Execute

remark()
  .use(
    updateReadme,
    {
      usage: 'information about using the project'
    }
  )
  .process(
    `# project-name

Description of the project

<!--status-badges start -->
<!--status-badges end -->

<!--consumer-badges start -->
<!--consumer-badges end -->

<!--contribution-badges start -->
<!--contribution-badges end -->
`,
    (err, file) => {
      fs.writeFileSync(`${process.cwd()}/README.md`, file.contents);
    }
  );

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test