From e0dc97bd6f738b06ee692bd52f0fceb6996c1625 Mon Sep 17 00:00:00 2001
From: Junhao Liao <junhao.liao@yscope.com>
Date: Thu, 13 Jun 2024 16:33:22 -0400
Subject: [PATCH] Update setup instructions in README.md.

---
 README.md | 47 ++++++++++++++++++++++++++---------------------
 1 file changed, 26 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 166efde..8918fe5 100644
--- a/README.md
+++ b/README.md
@@ -2,68 +2,73 @@
 
 This repository contains ESLint configurations for various JavaScript environments under the `yscope` namespace. Our configurations are designed to enforce a consistent coding style and catch common bugs, making your codebase more maintainable and error-free.
 
-## Available Configurations
-
-- `yscope/common`: A general ESLint configuration suitable for a wide range of JavaScript projects.
-- `yscope/react`: Tailored ESLint configuration for React applications.
-- `yscope/meteor`: A specialized ESLint configuration for Meteor projects.
-- `yscope/typescipt`: Designed specifically for TypeScript applications.
 ## Installation
 
 To get started with `eslint-config-yscope`, you can install the package:
+
 ```shell
 npm install --save-dev eslint-config-yscope
 # or
 yarn add --dev eslint-config-yscope
 ```
+
 ### For Older Node.js Versions
+
 If you are using `npm` version >= 3 or < 7, you need to install the `peerDependencies` specified in https://github.com/y-scope/eslint-config-yscope/blob/95089c98636bbcb01f282188b521ea8e7f898038/package.json#L13-L24
+
 Alternatively, you can upgrade your `npm` to the latest version compatible with your Node.js version.
 - Node.js verions below v16: `npm i -g npm@9`
 - Node.js v16 or above: `npm i -g npm@latest`
 
 ## Usage
+
 After installation, you can use one of the configurations by adding it to the `extends` section in your `.eslintrc` (or `.eslintrc.js`, `.eslintrc.json`, etc.) file, or in an attribute named `eslintConfig` in your `package.json` file.
-eslintConfig
-### For Common Configuration
+
+### ESLint config example
+
 ```json
 {
   "extends": ["yscope/common"]
 }
 ```
 
-### For React Configuration
-```json
-{
-  "extends": ["yscope/react"]
-}
-```
+### Available Configurations
 
-### For Meteor Configuration
-```json
-{
-  "extends": ["yscope/meteor"]
-}
-```
+The available configs are:
+
+- `yscope/common`: A general ESLint configuration suitable for a wide range of JavaScript projects.
+- `yscope/react`: Tailored ESLint configuration for React applications.
+- `yscope/meteor`: A specialized ESLint configuration for Meteor projects.
+- `yscope/typescipt`: Designed specifically for TypeScript applications.
 
 ### For TypeScript Configuration
+
 TypeScript-related dependencies are not automatically installed because not every configuration requires them.
 Before you can use this configuration, you need to install the dependencies manually.
+
 ```shell
 npm install --save-dev eslint-import-resolver-typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin
 ```
+
 Then in your ESLint configuration:
+
 ```json
 {
-  "extends": ["yscope/typescript"]
+  "extends": [
+    "yscope/common",
+    "yscope/typescript"
+  ]
 }
 ```
 
 ## Customization
+
 Each configuration can be further customized and extended as per your project's needs. You can override specific rules by adding them to your ESLint configuration file.
 
 ## Contributing
+
 We welcome contributions to the `eslint-config-yscope`! If you have suggestions or improvements, feel free to open an issue or a pull request.
 
 ## License
+
 This project is licensed under Apache License 2.0. Please see the [LICENSE](https://github.com/y-scope/eslint-config-yscope/blob/main/LICENSE) file for more details.