diff --git a/README.md b/README.md index c8737c10a..e10a5aaf1 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,8 @@ Consider taking a peek at the relevant documentation: 🤔 ## Usage +> ⚠ Coming from Angular? Use **[angular-eslint](https://github.com/angular-eslint/angular-eslint#migrating-an-angular-cli-project-from-codelyzer-and-tslint)** instead to coordinate around this tool and others. + ```shell npx tslint-to-eslint-config ``` @@ -162,7 +164,6 @@ _Default: `tsconfig.json`_ Path to a TypeScript configuration file to read TypeScript compiler options from. This will help inform the generated ESLint configuration file's [env](https://eslint.org/docs/user-guide/configuring#specifying-parser-options) settings. - ## Node API You can use `tslint-to-eslint-config` programmatically via its exported functions.