Skip to content

Commit 2cfe359

Browse files
committed
docs(Readme): how to setup
Closes #20
1 parent df81b7b commit 2cfe359

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

+17
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22

33
A set of tslint rules for static code analysis of Angular 2 TypeScript projects.
44

5+
## Install
6+
7+
`npm install --save-dev codelyzer`
8+
9+
Then hop to your `tslint.json` and add rulesDirectory which points to codelyzer, like this:
10+
```json
11+
{
12+
"rulesDirectory": [
13+
"node_modules/codelyzer/dist/src"
14+
],
15+
"rules":{
16+
}
17+
}
18+
```
19+
20+
Now you can apply codelyzer rules to your tslint config. Enjoy!
21+
522
## Recommended configuration
623

724
Below you can find a recommended configuration which is based on the [Angular 2 Style Guide](https://github.com/mgechev/angular2-style-guide).

0 commit comments

Comments
 (0)