readme-factory

1.0.0 • Public • Published

readme-factory

quickly template out README files for module documentation

install

npm install readme-factory -g

usage

From your npm modules root, do:

readme-factory > README.md

README.md will be auto populated based on your package.json. It's really just to speed the tedious process up. Nothing magical!

Right now, it passes over:

  • Package name
  • Package license
  • Package description

As well as boiler-plating some headers, etc.

todo: it might be nice to add more templates, for example, one for command-line tools.

license

MIT

Dependencies (1)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i readme-factory

    Weekly Downloads

    0

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • alexander-daniel