Permalink
Browse files

Docs: Update references to `--init`

Close #1215
  • Loading branch information...
molant authored and alrra committed Aug 7, 2018
1 parent 9c334e9 commit 68ddc908f8f198641df5b3b2dd74ae2c1897b913
@@ -20,11 +20,7 @@ Run the following command:
npx hint https://example.com
```
This will start the wizard to create a `.hintrc` file, and then
analyze `https://example.com`.
**Windows users**: Currently [`npx` has an issue in this
platform](https://github.com/npm/npm/issues/17869).
This will analyze `https://example.com` using the default configuration.
### Installing `webhint` globally
@@ -36,7 +32,7 @@ Create a `.hintrc` file by running this command and following the
instructions:
```bash
hint --init
npm create hintrc
```
Scan a website:
@@ -14,11 +14,7 @@ Run the following command:
npx hint https://example.com
```
This will start the wizard to create a `.hintrc` file, and then
analyze `https://example.com`.
**Windows users**: Currently [`npx` has an issue in this
platform](https://github.com/npm/npm/issues/17869).
This will analyze `https://example.com` using the default configuration.
### Installing `webhint` globally
@@ -30,7 +26,7 @@ Create a `.hintrc` file by running this command and following the
instructions:
```bash
hint --init
npm create hintrc
```
Scan a website:
@@ -11,7 +11,7 @@ as well.
To use a `configuration`, you have to:
1. After installing `webhint`, install a configuration package. When running
`--init`, the wizard will list you the official configuration packages but
`npm create hintrc`, the wizard will list you the official configuration packages but
you can search on `npm`. Any package `@hint/configuration-` or
`webhint-configuration-` should be a valid candidate.
2. Once installed, update your `.hintrc` to use it (this step is not needed
@@ -6,23 +6,27 @@ If you want to have an idea of what `webhint` does and you
have an updated version of `npm` (v5.2.0) and [Node LTS (v8.9.2)
or later][nodejs] you can use the following command:
```bash
npm hint https://example.com
```
Alternatively, you can install it locally with:
```bash
npm install -g --engine-strict hint
```
You can also install it as a `devDependency` if you prefer not to
have it globally.
have it globally (which is the team's preferred option).
The next thing that `webhint` needs is a `.hintrc` file. By
default, `webhint` will look for this file first in the current
folder and then in the user's home directory.
The fastest and easiest way to create one is by using the flag `--init`:
The fastest and easiest way to create one is by running:
```bash
hint --init
npm create hintrc
```
This command will start a wizard that will ask you a series of

0 comments on commit 68ddc90

Please sign in to comment.