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..ab0b463c45babb5e44b13cfb5111525c44201860
--- /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
+
+(As root, or using sudo.)

[Wladimir Palant, 2017/02/14 12:43:20]

Nit: I'm not a big fan of having an entire sentence in parentheses (yes, Dave
disagrees). How about:

  This command requires administrator privileges so you might need to use sudo.

No "root" (which a Unix detail) and no parentheses.

[kzar, 2017/02/15 05:24:22]

(Done.)

+
+## Usage
+
+To lint a JavaScript file using ESLint you simply run the `eslint` command with

[Wladimir Palant, 2017/02/14 12:43:20]

Nit: Please avoid using the word "simply" in instructions. You don't want to
make people feel stupid if it turns out complicated in the end ;)

[kzar, 2017/02/15 05:24:22]

Good point, Done.

+the file as an argument. For example:
+
+    eslint some-file.js
+
+(For advanced usage see `eslint --help`.)

[Wladimir Palant, 2017/02/14 12:43:20]

Nit: Parentheses are unnecessary here.

[kzar, 2017/02/15 05:24:22]

Done.

+
+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.)

[Wladimir Palant, 2017/02/14 12:43:20]

Nit: Parentheses are unnecessary here.

[kzar, 2017/02/15 05:24:22]

Done.