Skip to content

Commit 249eb40

Browse files
author
Kai Cataldo
committed
Docs: Clarify init sets up local installation (fixes #5874)
1 parent 864c5eb commit 249eb40

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ After that, you can run ESLint on any JavaScript file:
4040

4141
eslint test.js test2.js
4242

43+
**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.
44+
4345
## Configuration
4446

4547
After running `eslint --init`, you'll have a `.eslintrc` file in your directory. In it, you'll see some rules configured like this:

0 commit comments

Comments
 (0)