update readme regarding compatibility of rules

Author: chrisbreiding

README.md

@@ -21,9 +21,6 @@ Add an `.eslintrc.json` file to your `cypress` directory with the following:
   "plugins": [
     "cypress"
   ],
-  "extends": [
-    "plugin:cypress/recommended"
-  ],
   "env": {
     "cypress/globals": true
   }
@@ -32,16 +29,22 @@ Add an `.eslintrc.json` file to your `cypress` directory with the following:
 
 ## Rules
 
-Rules are grouped by category to help you understand their purpose.
+These rules enforce some of the [best practices recommended for using Cypress](https://on.cypress.io/best-practices). Use them by adding the following to your eslint config:
 
-Rules with a check mark (✅) are enabled by default while using
-the `plugin:cypress/recommended` config.
+```json
+// my-project/cypress/.eslintrc.json
 
-The --fix option on the command line automatically fixes problems reported by
-rules which have a wrench (🔧) below.
+{
+  // ... other config ...
+  "extends": [
+    "plugin:cypress/recommended"
+  ]
+}
+```
 
+Rules with a check mark (✅) are enabled by default while using the `plugin:cypress/recommended` config.
 
-### Possible Errors
+**NOTE**: These rules currently require eslint 5.0 or greater. If you would like support added for eslint 4.x, please 👍  [this issue](https://github.com/cypress-io/eslint-plugin-cypress/issues/14).
 
 |    | Rule ID | Description |
 |:---|:--------|:------------|

docs/rules/no-assigning-return-values.md

@@ -1,3 +1,3 @@
 ## No Assigning Return Values
 
-See [the Cypress Best Practices guide](https://docs.cypress.io/guides/references/best-practices.html#Assigning-Return-Values).
+See [the Cypress Best Practices guide](https://on.cypress.io/best-practices#Assigning-Return-Values).

docs/rules/no-unnecessary-waiting.md

@@ -1,3 +1,3 @@
 ## No Assigning Return Values
 
-See [the Cypress Best Practices guide](https://docs.cypress.io/guides/references/best-practices.html#Unnecessary-Waiting).
+See [the Cypress Best Practices guide](https://on.cypress.io/best-practices#Unnecessary-Waiting).

lib/rules/no-assigning-return-values.js

@@ -22,7 +22,7 @@ module.exports = {
       description: 'Prevent assigning return values of cy calls',
       category: 'Possible Errors',
       recommended: true,
-      url: 'https://docs.cypress.io/guides/references/best-practices.html#Assigning-Return-Values',
+      url: 'https://on.cypress.io/best-practices#Assigning-Return-Values',
     },
     schema: [],
     messages: {

lib/rules/no-unnecessary-waiting.js

@@ -11,7 +11,7 @@ module.exports = {
       description: 'Prevent waiting for arbitrary time periods',
       category: 'Possible Errors',
       recommended: true,
-      url: 'https://docs.cypress.io/guides/references/best-practices.html#Unnecessary-Waiting',
+      url: 'https://on.cypress.io/best-practices#Unnecessary-Waiting',
     },
     schema: [],
     messages: {