From 249eb40d77e9a3b3be4de5e633bf87589d314219 Mon Sep 17 00:00:00 2001 From: Kai Cataldo Date: Wed, 20 Apr 2016 22:33:30 -0400 Subject: [PATCH] Docs: Clarify init sets up local installation (fixes #5874) --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index eccb5ac0047c..9cbb09092647 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,8 @@ After that, you can run ESLint on any JavaScript file: eslint test.js test2.js +**Note:** `eslint --init` is intended for setting up and configuring ESLint on a per-project basis and will perform a local installation of ESLint and its plugins in the directory in which it is run. If you prefer using a global installation of ESLint, any plugins used in your configuration must also be installed globally. + ## Configuration After running `eslint --init`, you'll have a `.eslintrc` file in your directory. In it, you'll see some rules configured like this: