arcanis / clipanion

Type-safe CLI library / framework with no runtime dependencies
https://mael.dev/clipanion/
1.12k stars 66 forks source link

Add documentation for help #84

Closed arthuro555 closed 3 years ago

arthuro555 commented 3 years ago

Hello 👋 ! This is my first contribution here and I hope I haven't done anything wrong. I couldn't find any autoformat script so I just used prettier with default settings for the snippets.

This PR adds a documentation page about the usage member and help builtin command. I think it is useful because I couldn't understand the help command until I found the Usage type in the typescript definitions, which is maybe a bit too "hidden" for the average user. English is not my mother tongue so please check for typos/style errors before merging 😓.

arcanis commented 3 years ago

Good idea, thanks!