Issue 3692 - Add base ESLint configuration

eslint-config-eyeo/README.md

Index: eslint-config-eyeo/README.md
diff --git a/eslint-config-eyeo/README.md b/eslint-config-eyeo/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..d9d2ec731df2b268969f7e9c06c5cc28f49f805a
--- /dev/null
+++ b/eslint-config-eyeo/README.md
@@ -0,0 +1,32 @@
+# eslint-config-eyeo
+
+An [ESLint](http://eslint.org) configuration that checks for compliance with the
+[Adblock Plus coding style guide](https://adblockplus.org/coding-style#javascript)
+which is used for all eyeo projects.
+
+## Installation
+
+    npm install -g eslint eslint-config-eyeo
+
+This command requires administrator privileges so you might need to use sudo.

[Sebastian Noack, 2017/02/15 10:35:24]

Nit: While you wrapped other commands in backticks, it seems you forgot to do so
for "sudo", here.

[kzar, 2017/02/15 11:45:20]

Done.

+
+## Usage
+
+To lint a JavaScript file using ESLint you run the `eslint` command with the
+file as an argument. For example:
+
+    eslint some-file.js
+
+For advanced usage see `eslint --help`.
+
+In order to use eslint-config-eyeo your project's ESLint configuration
+should extend from it. A minimal example looks like this:
+
+    {
+      "extends": "eslint-config-eyeo",
+      "root": true
+    }
+
+For projects without an ESLint configuration you can create your own
+personal configuration in `~/.eslintrc.json`, but take care to remove
+the `"root": true` section from the above example.