diff --git a/README.md b/README.md index 05025a0..f9e8c11 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,17 @@ Recommended ESLint Shareable Config for TypeScript +## Overview + +`@eslint-recommended/eslint-config-typescript` is using following configurations. + +- [eslint-config-standard-with-typescript](https://www.npmjs.com/package/eslint-config-standard-with-typescript) +- [eslint-plugin-unicorn](https://www.npmjs.com/package/eslint-plugin-unicorn)'s recommended +- [eslint-plugin-eslint-comments](https://www.npmjs.com/package/eslint-plugin-eslint-comments)'s recommended + ## Peer dependencies +- [@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin) - [eslint](https://www.npmjs.com/package/eslint) - [eslint-config-standard-with-typescript](https://www.npmjs.com/package/eslint-config-standard-with-typescript) - [eslint-plugin-eslint-comments](https://www.npmjs.com/package/eslint-plugin-eslint-comments) @@ -14,7 +23,7 @@ Recommended ESLint Shareable Config for TypeScript - [eslint-plugin-n](https://www.npmjs.com/package/eslint-plugin-n) - [eslint-plugin-promise](https://www.npmjs.com/package/eslint-plugin-promise) - [eslint-plugin-unicorn](https://www.npmjs.com/package/eslint-plugin-unicorn) -- [@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin) +- [typescript](https://www.npmjs.com/package/typescript) ## Usage @@ -34,6 +43,7 @@ Install `@eslint-recommended/eslint-config-typescript` and its peer dependencies ```sh npm i -D \ + @typescript-eslint/eslint-plugin \ eslint \ eslint-config-standard-with-typescript \ eslint-plugin-eslint-comments \ @@ -41,7 +51,7 @@ npm i -D \ eslint-plugin-n \ eslint-plugin-promise \ eslint-plugin-unicorn \ - @typescript-eslint/eslint-plugin \ + typescript \ @eslint-recommended/eslint-config-typescript ```