https://github.com/jbenner-radham/node-readme-md-cli

Automatically generate a readme for your project from the CLI.
https://github.com/jbenner-radham/node-readme-md-cli

cli docs documentation generator markdown md readme

Last synced: over 1 year ago
JSON representation

Automatically generate a readme for your project from the CLI.

• Host: GitHub
• URL: https://github.com/jbenner-radham/node-readme-md-cli
• Owner: jbenner-radham
• License: mit
• Created: 2017-07-20T17:58:52.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2022-12-25T16:02:09.000Z (over 3 years ago)
• Last Synced: 2024-04-24T19:31:59.133Z (about 2 years ago)
• Topics: cli, docs, documentation, generator, markdown, md, readme
• Language: JavaScript
• Homepage:
• Size: 971 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
readme-md-cli

=============

[![Build Status](https://img.shields.io/github/actions/workflow/status/jbenner-radham/node-readme-md-cli/ci.yaml?branch=main&style=flat)](https://github.com/jbenner-radham/node-readme-md-cli/actions/workflows/ci.yaml)

[![npm Version](https://img.shields.io/npm/v/readme-md-cli.svg?style=flat)](https://www.npmjs.com/package/readme-md-cli)

[![Node.js Version](https://img.shields.io/node/v/readme-md-cli.svg?style=flat)](https://nodejs.org/)

[![License Type](https://img.shields.io/github/license/jbenner-radham/node-readme-md-cli.svg?style=flat)](LICENSE)

Automatically generate a readme for your project from the CLI.

![Animated demo of readme-md](images/demo.gif)

Install

-------

```sh

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

```

Usage

-----

```sh-session

$ readme-md --help

  Automatically generate a readme for your project from the CLI.

  Usage

      $ readme-md [init]

  Options

      --help, -h               Display this message.

      --non-interactive, -n    Run in non-interactive mode.

      --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](doc/) or view the [project's config directory](.config/readme-md/) for example usage.

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

Testing

-------

```sh

yarn test # Or alternatively: `npm test`

```

See Also

--------

- [readme-md @ npm](https://www.npmjs.com/package/readme-md)

License

-------

The MIT License. See the [license file](LICENSE) for details.