readme-cli-help
Maintain the output of a help command in your README
file.
Usage
- Include the following in your
README.md
file:
````cli-help This text will be replaced by the output of the help command. ````
- Add the following command to your project (e.g. to your
Makefile
orpackage.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"