readme-md-cli

Automatically generate a readme for your project from the CLI.

Install

yarn global add readme-md-cli # Or alternatively: `npm install --global readme-md-cli`

Usage

$ readme-md --help

  Automatically generate a readme for your project from the CLI.

  Usage
      $ readme-md [init]

  Options
      --help, -h       Display this message.
      --version, -v    Display the application version.

  When invoked with the "init" sub-command a project level runtime
  configuration is initialized.

For more detailed information see the doc directory. Or view the project's config directory for example usage.

For example output, this README.md is entirely self generated by this package.

Testing

yarn test # Or alternatively: `npm test`

See Also

• readme-md @ npm

License

The MIT License. See the license file for details.