Skip to content
Permalink
Browse files

Docs: Update readme and docs with missing information

* Add new categories of hint - development and pitfalls
* Typo fixes
* Fix broken links in FAQ

- - - - - - - - - -

Close #2770
  • Loading branch information...
jaspreet57 authored and antross committed Aug 2, 2019
1 parent 29e8909 commit 68b632d68b998e75c8027776cf96d58ed1961a6e
Showing with 6 additions and 4 deletions.
  1. +1 −1 README.md
  2. +2 −2 packages/hint/docs/about/FAQ.md
  3. +3 −1 packages/hint/docs/contributor-guide/how-to/hint.md
@@ -6,7 +6,7 @@

## Quick start user guide

Once you have [`Node.js`][node] v8.x on your machine, you can use
Once you have [`Node.js`][node] (v8.x or later) on your machine, you can use
[`npx`][npx] or install `hint` globally to use it.

### Using `npx`
@@ -45,7 +45,7 @@ Also don’t hesitate to ask for help.

`webhint` currently supports [jsdom][jsdom], Chrome, and Edge 15.
We hope to add support for Firefox soon. If your favorite browser
is not supported you can always [develop a connector][new issue]
is not supported you can always [develop a connector][connector docs]
for it!

## Is there a plugin for my favorite editor?
@@ -92,7 +92,7 @@ telling us what you think can be improved.
<!-- Link labels: -->

[axe]: https://axe-core.org/
[connector docs]: /docs/contributor-guide/connectors/
[connector docs]: https://webhint.io/docs/contributor-guide/how-to/connector/
[issues]: https://github.com/webhintio/hint/issues
[jsdom]: https://github.com/tmpvar/jsdom
[narwhal echolocation]: http://journals.plos.org/plosone/article?id=10.1371/journal.pone.0162069
@@ -13,7 +13,7 @@ how to do it, please [open an issue][new issue].

## Using the `CLI` to create a hint

The easiest wait to create a new hint is via the `create-hint` package:
The easiest way to create a new hint is via the `create-hint` package:

```bash
npm init hint
@@ -25,9 +25,11 @@ related to this new hint. A complete list of the questions is shown below:
* What’s the name of this new hint?
* Please select the category of this new hint:
* accessibility
* development
* compatibility
* performance
* pwa
* pitfalls
* security
* What’s the description of this new hint?
* Please select the category of use case:

0 comments on commit 68b632d

Please sign in to comment.
You can’t perform that action at this time.