Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
amio committed Aug 23, 2019
1 parent 1d71a1f commit f0b731d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@

Missing inspector for npm packages.

![nls-screenshot][screenshot]

## Install & Usage

```bash
npm install -g nls
```

![nls-screenshot][screenshot]

## Usage

```bash
Usage

$ nls [<target-dir>] List available npm scripts.
$ nls why <package-name> Identifies why a package has been installed.
$ nls why <package-name> Identify why a package has been installed.
$ nls read <package-name> Print readme file for a specified package.

Options

Expand All @@ -31,6 +32,9 @@ Examples

# Find who depend upon package 'chalk'.
$ nls why chalk

# Print readme file for 'glob'
$ nls read glob
```

## Related
Expand Down
4 changes: 2 additions & 2 deletions lib/nls
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ const help = `
Usage
$ nls [<target-dir>] ${kleur.dim('List available npm scripts.')}
$ nls why <package-name> ${kleur.dim('Identifies why a package has been installed.')}
$ nls read <package-name> ${kleur.dim('Show readme file for specified package.')}
$ nls why <package-name> ${kleur.dim('Identify why a package has been installed.')}
$ nls read <package-name> ${kleur.dim('Print readme file for a specified package.')}
Options
Expand Down

0 comments on commit f0b731d

Please sign in to comment.