Create README.md

Author: chinchiheather

README.md

@@ -0,0 +1,41 @@
+# cypress-eslint
+Cypress plugin that will run linting via ESLint on your spec files and display linting errors in your terminal.
+
+This uses the `file:preprocessor` event which means it will lint files as they are loaded by Cypress. If you are running your full suite of tests, all the spec files will be linted, but if you are only running tests on a specific test suite then only the files that it loads will be linted.
+
+This will use the `.eslintrc` file in your project root combined with the `.eslintrc` file in your Cypress directory (if you have one). This means you can easily set custom rules just for your Cypress spec files.
+
+## Install
+
+```bash
+# npm
+npm i cypress-eslint --save-dev
+
+# yarn
+yarn add cypress-eslint --dev
+```
+
+## Usage
+
+If you are not currently using another plugin on the `file:preprocessor` event
+```javascript
+// cypress/plugins/index.js
+const cypressEslint = require('cypress-eslint');
+
+module.exports = (on) => {
+    on('file:preprocessor', cypressEslint());
+};
+
+```
+
+If you are using another plugin on the `file:preprocessor` event, pass this in as a parameter to cypress eslint
+```javascript
+// cypress/plugins/index.js
+
+const cypressEslint = require('cypress-eslint');
+const babelEsX = require('cypress-babel-esx');
+
+module.exports = (on) => {
+    on('file:preprocessor', cypressEslint(babelEsX()));
+};
+```