Show simple documentation on how to use when running npx @svgr/cli

[lwkchan]

🚀 Feature Proposal

After installing the @svgr/cli package, user should simply be able to run npx @svgr/cli without any parameters and see simple documentation on how to use the cli tool.

Motivation

I spent a while trying to figure out how to use the @svgr/cli tool after trying countless times to run npx @svgr/cli. The result, just a hanging terminal which does not stop the node process.

I tried to run this command simply to find out whether the tool was installed properly. (a bit like just running npm in the terminal and seeing how to use it).

Example

As a start, we could just put its simple usage as shown the documentation

$ npx @svgr/cli
Usage: npx @svgr/cli [-d out-dir] [src-dir]

The Pitch

This would allow the user to see simply how to use the tool and that the tool has been installed correctly.

[gregberge]

Hello @lwkchan, unfortunately it is not possible because it would break the stdin usage:

npx @svgr/cli < file.svg

[gregberge]

Oh maybe its possible, it worth the try!

[gregberge]

Will be fixed in v5.