readme-cli-help

0.1.7 • Public • Published

readme-cli-help

Maintain the output of a help command in your README file.

Usage

  1. Include the following in your README.md file:
````cli-help
This text will be replaced by the output of the help command.
````
  1. Add the following command to your project (e.g. to your Makefile or package.json):
bun x readme-cli-help "./my-command --help"`

Example

The following is a block itself generated using readme-cli-help:

Usage: readme-cli-help [--help] [--fence FENCE] [--readme-path PATH] "./my/command --help"

Readme

Keywords

none

Package Sidebar

Install

npm i readme-cli-help

Weekly Downloads

0

Version

0.1.7

License

none

Unpacked Size

12.9 kB

Total Files

9

Last publish

Collaborators

  • lgarron