Skip to content

Commit

Permalink
Use npx in readme usage instructions (#139)
Browse files Browse the repository at this point in the history
  • Loading branch information
morinted committed Apr 13, 2021
1 parent 05f96e7 commit e8840c7
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,14 @@ Includes a bunch of [general Markdown rules](config.js) and some [Awesome specif

## CLI

### Install

Install Node.js and Git, then run:

```
$ npm install --global awesome-lint
```

### Usage

Type the command `awesome-lint` followed by the URL of the repo you want to check:
The CLI requires Node.js and Git.

Type the command `npx awesome-lint` followed by the URL of the repo you want to check:

```
❯ awesome-lint https://github.com/sindresorhus/awesome-something
npx awesome-lint https://github.com/sindresorhus/awesome-something
readme.md:1:1
✖ 1:1 Missing Awesome badge after the main heading awesome-badge
Expand Down

0 comments on commit e8840c7

Please sign in to comment.