Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use npx in readme usage instructions #139

Merged
merged 1 commit into from
Apr 13, 2021
Merged

Use npx in readme usage instructions #139

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 4 additions & 10 deletions readme.md
View file
Open in desktop
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