Docs: Update README.md information

webhintio · Mar 29, 2019 · 695a61e · 695a61e
1 parent ec2243b
commit 695a61e
Showing 1 changed file with 21 additions and 27 deletions.
diff --git a/packages/hint/README.md b/packages/hint/README.md
@@ -2,48 +2,42 @@
 
 ## Quick start user guide
 
-Once you have [`Node.js`](https://nodejs.org/en/download/current/)
+If you want to have an idea of what `webhint` does and you
-v8.x on your machine, you can use `npx` or install `hint` globally
+have an updated version of `npm` (v5.2.0) and [Node.js LTS (v8.9.2)
-to use it.
+or later, x64 version recommended][https://nodejs.org/en/download/current/]
-
+you can use the following command:
-**Note**: Only the latest 2 LTS versions of node and the current
-one are supported.
-
-### Using `npx`
-
-Run the following command:
 
 ```bash
 npx hint https://example.com
 ```
 
-This will analyze `https://example.com` using the default configuration.
+Alternatively, you can install it globally with:
-
-### Installing `webhint` globally
 
 ```bash
 npm install -g --engine-strict hint
+
+hint https://example.com
 ```
 
-Create a `.hintrc` file by running this command and following the
+You can also install it as a `devDependency` if you prefer not to
-instructions:
+have it globally (which is the team's preferred option).
 
-```bash
+**NOTE**: If you run into any issues during the install process
-npm create hintrc
+please check the [troubleshoot section](./troubleshoot/summary.md).
-```
 
-Scan a website:
 
-```bash
+### Further reading
-hint https://example.com
+
-```
+Now that you have `webhint` up and running, it is time to learn a bit
+more about the different pieces:
 
-For more in depth information on how to get started, configurations,
+* [Configurations](./concepts/configurations.md)
-and more, see the online [user guide](https://webhint.io/docs/user-guide/),
+* [Hints](./concepts/hints.md)
-or the [local version](./docs/user-guide/index.md)
+* [Connectors](./concepts/connectors.md)
-for the most recent (and unstable) content.
+* [Formatters](./concepts/formatters.md)
+* [Parsers](./concepts/parsers.md)
 
-## Contributing to hint
+## Contributing to webhint
 
 To know more about the internals of `webhint`, the structure of the
 project, how to create new hints, collectors, formatters, etc, take a