Merge pull request eslint#5919 from eslint/fixes5874

Docs: Clarify init sets up local installation (fixes eslint#5874)
EnableSoftware · Apr 21, 2016 · 8d1deb3 · 8d1deb3
2 parents 864c5eb + 249eb40
commit 8d1deb3
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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: