From 16cdeed33908db27b304ca4f744da572e3165882 Mon Sep 17 00:00:00 2001
From: Will Harney <62956339+wjhsf@users.noreply.github.com>
Date: Thu, 17 Oct 2024 11:15:18 -0400
Subject: [PATCH] Update README.md

I looked at the README and I decided that the headings too long, so I tidied that up a bit.
---
 README.md | 22 ++++++++++++++++------
 1 file changed, 16 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 8e16ae0..ae05d2e 100644
--- a/README.md
+++ b/README.md
@@ -43,9 +43,9 @@ Example `.eslintrc`:
 
 ## Configurations
 
-This package exposes multiple configurations for your usage. Each configuration listed below is available for both JavaScript projects (no suffix) and TypeScript projects (with `-ts` suffix).
+This package exposes multiple configurations for your usage. Each configuration listed below is available for both JavaScript projects and TypeScript projects (when using `-ts` suffix).
 
-### `@salesforce/eslint-config-lwc/base` and `@salesforce/eslint-config-lwc/base-ts` configurations
+### `@salesforce/eslint-config-lwc/base`
 
 **Goal:**
 Prevent common pitfalls with LWC, and enforce other Salesforce platform restrictions.
@@ -53,7 +53,9 @@ Prevent common pitfalls with LWC, and enforce other Salesforce platform restrict
 **Rules:**
 [_LWC specific rules_](https://github.com/salesforce/eslint-plugin-lwc/blob/master/README.md#lwc) only.
 
-### `@salesforce/eslint-config-lwc/recommended` and `@salesforce/eslint-config-lwc/recommended-ts` configurations
+**TypeScript:** Use `@salesforce/eslint-config-lwc/base-ts` to use this config in TypeScript projects.
+
+### `@salesforce/eslint-config-lwc/recommended`
 
 **Goal:**
 Prevent common Javascript pitfalls and enforce all best practices.
@@ -61,7 +63,9 @@ Prevent common Javascript pitfalls and enforce all best practices.
 **Rules:**
 `@salesforce/eslint-config-lwc/base` rules + Most of the base [_Potential errors_](https://eslint.org/docs/rules/#possible-errors) rules + Some of the [_Best Practices_](https://eslint.org/docs/rules/#best-practices) rules + [_LWC Best Practices_](https://github.com/salesforce/eslint-plugin-lwc/blob/master/README.md#best-practices).
 
-### `@salesforce/eslint-config-lwc/extended` and `@salesforce/eslint-config-lwc/extended-ts` configurations
+**TypeScript:** Use `@salesforce/eslint-config-lwc/recommended-ts` to use this config in TypeScript projects.
+
+### `@salesforce/eslint-config-lwc/extended`
 
 **Goal:**
 Restrict usage of some Javascript language features known to be slow after the _COMPAT_ transformation. LWC runs in _COMPAT_ mode on older browsers (eg. IE11). To support new Javascript syntax and language features on older browser the LWC compiler transforms LWC modules. This linting configuration targets patterns known to be slow in _COMPAT_ mode.
@@ -69,7 +73,9 @@ Restrict usage of some Javascript language features known to be slow after the _
 **Rules:**
 `@salesforce/eslint-config-lwc/recommended` rules + restrict usage of some slow patterns in [_COMPAT_](https://github.com/salesforce/eslint-plugin-lwc/blob/master/README.md#compat-performance).
 
-### `@salesforce/eslint-config-lwc/i18n` and `@salesforce/eslint-config-lwc/i18n-ts` configurations
+**TypeScript:** Use `@salesforce/eslint-config-lwc/extended-ts` to use this config in TypeScript projects.
+
+### `@salesforce/eslint-config-lwc/i18n`
 
 **Goal:**
 Promote usage of `@salesforce/i18n-service` over 3rd parties, promote internationalization (I18N) best practices.
@@ -87,7 +93,9 @@ Add the `i18n` configuration to the `extends` field in your `.eslintrc` configur
 }
 ```
 
-### `@salesforce/eslint-config-lwc/ssr` and `@salesforce/eslint-config-lwc/ssr-ts` configurations
+**TypeScript:** Use `@salesforce/eslint-config-lwc/i18n-ts` to use this config in TypeScript projects.
+
+### `@salesforce/eslint-config-lwc/ssr`
 
 **Goal:**
 Promote writing server-side-rendering friendly components. We only recommend using this configuration if your components are running in experiences supporting LWC server-side-rendering.
@@ -104,3 +112,5 @@ Add the `ssr` configuration to the `extends` field in your `.eslintrc` configura
     "extends": ["@salesforce/eslint-config-lwc/recommended", "@salesforce/eslint-config-lwc/ssr"]
 }
 ```
+
+**TypeScript:** Use `@salesforce/eslint-config-lwc/ssr-ts` to use this config in TypeScript projects.