From bc692a9bf5c664c646ce386eff44eb706c231127 Mon Sep 17 00:00:00 2001 From: Strek Date: Tue, 12 Jul 2022 06:21:53 +0530 Subject: [PATCH] docs: remove install command (#16084) * docs: remove install command * chore: update readme * chore: fix review comments --- README.md | 8 +------- docs/src/user-guide/getting-started.md | 16 +--------------- 2 files changed, 2 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index eeb062e9d3b..309db3dc849 100644 --- a/README.md +++ b/README.md @@ -45,13 +45,7 @@ ESLint is a tool for identifying and reporting on patterns found in ECMAScript/J Prerequisites: [Node.js](https://nodejs.org/) (`^12.22.0`, `^14.17.0`, or `>=16.0.0`) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.) -You can install ESLint using npm: - -```shell -npm install eslint --save-dev -``` - -You should then set up a configuration file: +You can install and configure ESLint using this command: ```shell npm init @eslint/config diff --git a/docs/src/user-guide/getting-started.md b/docs/src/user-guide/getting-started.md index 184ea122732..0004f40522b 100644 --- a/docs/src/user-guide/getting-started.md +++ b/docs/src/user-guide/getting-started.md @@ -20,24 +20,10 @@ ESLint is a tool for identifying and reporting on patterns found in ECMAScript/J Prerequisites: [Node.js](https://nodejs.org/en/) (`^12.22.0`, `^14.17.0`, or `>=16.0.0`) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.) -You can install ESLint using npm or yarn: - -```shell -npm install eslint --save-dev - -# or - -yarn add eslint --dev -``` - -You should then set up a configuration file, and the easiest way to do that is: +You can install and configure ESLint using this command: ```shell npm init @eslint/config - -# or - -yarn create @eslint/config ``` **Note:** `npm init @eslint/config` assumes you have a `package.json` file already. If you don't, make sure to run `npm init` or `yarn init` beforehand.