Skip to content

Commit 8a6a8f5

Browse files
committed
Merge pull request #142 from Gillespie59/development
0.2.2
2 parents 1e418a5 + 7eec79c commit 8a6a8f5

File tree

2 files changed

+29
-2
lines changed

2 files changed

+29
-2
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,34 @@ This repository will give access to new rules for the ESLint tool. You should us
88

99
Since the 0.0.4 release, some rules defined in [John Papa's Guideline](https://github.com/johnpapa/angular-styleguide) have been implemented. In the description below, you will have a link to the corresponding part of the guideline, in order to have more information.
1010

11-
# Usage
11+
# Usage with [shareable](http://eslint.org/docs/developer-guide/shareable-configs.html) config
12+
Users may use the shareable [eslint-config-angular](https://github.com/dustinspecker/eslint-config-angular) to quickly setup eslint-plugin-angular. It also marks Angular as a global variable and defines required ESLint rules to use this plugin.
13+
14+
1. Install `eslint` as a dev-dependency:
15+
16+
```shell
17+
npm install --save-dev eslint
18+
```
19+
20+
2. Install `eslint-plugin-angular` as a dev-dependency:
21+
22+
```shell
23+
npm install --save-dev eslint-plugin-angular
24+
```
25+
26+
3. Install `eslint-config-angular` as a dev-dependency:
27+
28+
```shell
29+
npm install --save-dev eslint-config-angular
30+
```
31+
32+
4. Use the shareable config by adding it to your `.eslintrc`:
33+
34+
```yaml
35+
extends: angular
36+
```
37+
38+
# Usage without shareable config
1239

1340
1. Install `eslint` as a dev-dependency:
1441

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "eslint-plugin-angular",
3-
"version": "0.2.1",
3+
"version": "0.2.2",
44
"description": "ESLint rules for AngularJS projects",
55
"main": "index.js",
66
"repository": {

0 commit comments

Comments
 (0)