Docs: Clarify package.json requirement in Getting Started (refs #13549)…

… (#13696) * Docs: Clarify package.json requirement in Getting Started (refs #13549) * Update docs/user-guide/getting-started.md
eslint · Sep 22, 2020 · 30b76c9 · 30b76c9
1 parent 044560d
commit 30b76c9
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/user-guide/getting-started.md b/docs/user-guide/getting-started.md
@@ -20,7 +20,7 @@ npm install eslint --save-dev
 yarn add eslint --dev
 ```
 
-You should then set up a configuration file:
+You should then set up a configuration file, and the easiest way to do that is to use the `--init` flag:
 
 ```
 $ npx eslint --init
@@ -30,6 +30,8 @@ $ npx eslint --init
 $ yarn run eslint --init
 ```
 
+**Note:** `--init` assumes you have a `package.json` file already. If you don't, make sure to run `npm init` or `yarn init` beforehand.
+
 After that, you can run ESLint on any file or directory like this:
 
 ```

diff --git a/eslint-7.8.0.tgz b/eslint-7.8.0.tgz