cacjs / cac

Simple yet powerful framework for building command-line apps.
MIT License
2.65k stars 104 forks source link

docs: add usage api #93

Closed yinm closed 3 years ago

yinm commented 4 years ago

It seems there aren't references to cli.usage(text) and command.usage(text). I think they exist in README.md is more useful, so I added.

https://github.com/cacjs/cac/blob/d2c6b8a169359d0a5f17f0e3aa30e9c0e0a920ad/src/CAC.ts#L60-L68

https://github.com/cacjs/cac/blob/d2c6b8a169359d0a5f17f0e3aa30e9c0e0a920ad/src/Command.ts#L58-L61

egoist commented 3 years ago

Can you commit the change locally or run yarn toc so that the Table of Contents gets updated?

yinm commented 3 years ago

@egoist Thanks your reply. I run yarn toc and committed https://github.com/cacjs/cac/pull/93/commits/b6d6e29cb5faa739d5715498ee93acfbb93676af .

egoist commented 3 years ago

:tada: This PR is included in version 6.7.2 :tada:

The release is available on:

Your semantic-release bot :package::rocket: