@form8ion/remark-readme

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

!Node CI Workflow Statusgithub-actions-ci-badgegithub-actions-ci-link

Table of Contents

• Usage

Installation Example

* [Import](#import)
* [Execute](#execute)

• Contributing

Dependencies Verification

Usage

!MIT licenselicense-badgelicense-link !npmnpm-badgenpm-link !Try @form8ion/remark-readme on RunKitrunkit-badgerunkit-link

Installation

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

Example

Import

import {promises as fs} from 'node:fs';
import {remark} from 'remark';
import updateReadme from '@form8ion/remark-readme';

Execute

const file = await 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 -->
`
  );

await fs.writeFile(`${process.cwd()}/README.md`, `${file}`);

Contributing

!PRs WelcomePRs-badgePRs-link !Commitizen friendlycommitizen-badgecommitizen-link !Conventional Commitscommit-convention-badgecommit-convention-link !semantic-releasesemantic-release-badgesemantic-release-link !Renovaterenovate-badgerenovate-link

Dependencies

$ nvm install
$ npm install

Verification

$ npm test