From 2e9379effb153e1989ffac9363a09b5a4e35dfdc Mon Sep 17 00:00:00 2001
From: Adam Trager <hello@adamtrager.com>
Date: Fri, 4 Nov 2022 12:37:31 -0400
Subject: [PATCH] [readme] Increase clarity around typescript configuration

---
 CHANGELOG.md | 6 +++++-
 README.md    | 2 +-
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 78bd21cf3..c2885b8c3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -46,6 +46,7 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
 - [Tests] [`no-restricted-paths`]: Tests for `import type` statements ([#2459], thanks [@golergka])
 - [Tests] [`no-restricted-paths`]: fix one failing `import type` test case, submitted by [@golergka], thanks [@azyzz228]
 - [Docs] automate docs with eslint-doc-generator ([#2582], thanks [@bmish])
+- [readme] Increase clarity around typescript configuration ([#2588], thanks [@Nfinished])
 
 ## [2.26.0] - 2022-04-05
 
@@ -1020,6 +1021,8 @@ for info on changes for earlier releases.
 
 [`memo-parser`]: ./memo-parser/README.md
 
+[#2588]: https://github.com/import-js/eslint-plugin-import/pull/2588
+[#2582]: https://github.com/import-js/eslint-plugin-import/pull/2582
 [#2570]: https://github.com/import-js/eslint-plugin-import/pull/2570
 [#2568]: https://github.com/import-js/eslint-plugin-import/pull/2568
 [#2546]: https://github.com/import-js/eslint-plugin-import/pull/2546
@@ -1051,9 +1054,9 @@ for info on changes for earlier releases.
 [#2374]: https://github.com/import-js/eslint-plugin-import/pull/2374
 [#2371]: https://github.com/import-js/eslint-plugin-import/pull/2371
 [#2367]: https://github.com/import-js/eslint-plugin-import/pull/2367
-[#2332]: https://github.com/import-js/eslint-plugin-import/pull/2332
 [#2358]: https://github.com/import-js/eslint-plugin-import/pull/2358
 [#2341]: https://github.com/import-js/eslint-plugin-import/pull/2341
+[#2332]: https://github.com/import-js/eslint-plugin-import/pull/2332
 [#2334]: https://github.com/import-js/eslint-plugin-import/pull/2334
 [#2330]: https://github.com/import-js/eslint-plugin-import/pull/2330
 [#2305]: https://github.com/import-js/eslint-plugin-import/pull/2305
@@ -1695,6 +1698,7 @@ for info on changes for earlier releases.
 [@mrmckeb]: https://github.com/mrmckeb
 [@msvab]: https://github.com/msvab
 [@mx-bernhard]: https://github.com/mx-bernhard
+[@Nfinished]: https://github.com/Nfinished
 [@nickofthyme]: https://github.com/nickofthyme
 [@nicolashenry]: https://github.com/nicolashenry
 [@noelebrun]: https://github.com/noelebrun
diff --git a/README.md b/README.md
index 78344f35e..ed1e4f822 100644
--- a/README.md
+++ b/README.md
@@ -133,7 +133,7 @@ rules:
 
 # TypeScript
 
-You may use the following shortcut or assemble your own config using the granular settings described below.
+You may use the following snippet or assemble your own config using the granular settings described below it.
 
 Make sure you have installed [`@typescript-eslint/parser`] and [`eslint-import-resolver-typescript`] which are used in the following configuration.