showusage v0.1.0

showusage

Show pretty printed Usage section of a node package.

If the README file does not contain such section, the program suggest a list of alternative readings.

Installation

Run the following commands to download and install the application:

npm i showusage -g

Usage

showusage <NPM module> <README section>

• NPM module is the name, or path of the module within local or global to read.
• README section is the name or a regexp of the section's heading to extract.

How to contribute

1. File an issue in the repository, using the bug tracker, describing the contribution you'd like to make. This will help us to get you started on the right foot.
2. Fork the project in your account and create a new branch: your-great-feature.
3. Commit your changes in that branch.
4. Open a pull request, and reference the initial issue in the pull request message.

License

See the LICENSE file.