README.md

rereadme

an exploration on creating a readme file generator

Installation

npm i -D @maurusrv/rereadme // -D to add it as devDependency, since you will likely to use this code in your commit hook to automatically update your README

How To Use

const reREADME require('@maurusrv/rereadme')
...
await reREADME({ 
  outputPath: './README.md', 
  contents: {
    header, // optional string for title and description, or you can just use main for everything before the badges section
    main, // optional string of main content like Development Setup, etc.
    footer, // optional string for footer content after the badges section,
  },
  badges: true, // this adds a section with shields.io-powered list of dependencies. you may choose to not provide this param to not use badges generated with npm-check, otherwise this will go between main and footer, see Package Status of this README file
})

Package Status

dependencies

devDependencies

_{^{this README.md is generated by this package!}}