@freephoenix888/generate-usage-ways-of-npm-cli-apps-in-markdown-format
Version:
Generates usage ways of CLI applications of npm package in markdown format
31 lines (23 loc) • 1.13 kB
Markdown
[](https://www.npmjs.com/package/@freephoenix888/generate-usage-ways-of-npm-cli-apps-in-markdown-format)
[](https://gitpod.io/#https://github.com/freephoenix888/generate-usage-ways-of-npm-cli-apps-in-markdown-format)
Generates the ways to use CLI utilities of the package
# Table Of Contents
<!-- Do not remove these comments because they are used for automatic generation -->
<!-- TABLE_OF_CONTENTS_START -->
- [Table Of Contents](#table-of-contents)
- [Quick Start](#quick-start)
- [Library](#library)
<!-- TABLE_OF_CONTENTS_END -->
# Quick Start
- Add the following to your README.md
```markdown
<!-- CLI_USAGE_WAYS_START -->
<!-- CLI_USAGE_WAYS_END -->
```
- Run this javascript code
```javascript
await generateUsageWaysOfNpmCliAppsInMarkdownFormat({})
```
# Library
See [Documentation] for examples and API
[Documentation]: https://freephoenix888.github.io/generate-usage-ways-of-npm-cli-apps-in-markdown-format/