Skip to content

Commit 4559f44

Browse files
author
Josh Goldberg
authored
Added angular-eslint notice to README.md (#959)
1 parent 2729aae commit 4559f44

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ Consider taking a peek at the relevant documentation: 🤔
2121

2222
## Usage
2323

24+
> ⚠ 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.
25+
2426
```shell
2527
npx tslint-to-eslint-config
2628
```
@@ -162,7 +164,6 @@ _Default: `tsconfig.json`_
162164
Path to a TypeScript configuration file to read TypeScript compiler options from.
163165
This will help inform the generated ESLint configuration file's [env](https://eslint.org/docs/user-guide/configuring#specifying-parser-options) settings.
164166

165-
166167
## Node API
167168

168169
You can use `tslint-to-eslint-config` programmatically via its exported functions.

0 commit comments

Comments
 (0)