Skip to content

Commit 2d90ebf

Browse files
author
Jake Teton-Landis
committed
update README with new package structure
1 parent 7646a86 commit 2d90ebf

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

packages/eslint-config-airbnb/README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,26 @@ This package provides Airbnb's .eslintrc as an extensible shared config.
44

55
## Usage
66

7+
### With React Style
8+
79
1. `npm install --save-dev eslint-config-airbnb babel-eslint eslint-plugin-react`
8-
2. add `"extends": "eslint-config-airbnb"` to your .eslintrc
10+
2. add `"extends": "airbnb"` to your .eslintrc
11+
12+
### Without React Style
13+
14+
1. `npm install --save-dev eslint-config-airbnb babel-eslint `
15+
2. add `"extends": "airbnb/base"` to your .eslintrc
916

1017
See [Airbnb's Javascript styleguide](https://github.com/airbnb/javascript) and
1118
the [ESlint config docs](http://eslint.org/docs/user-guide/configuring#extending-configuration-files)
1219
for more information.
20+
21+
## Improving this config
22+
23+
Consider adding test cases if you're making complicated rules changes, like
24+
anything involving regexes. Perhaps in a distant future, we could use literate
25+
programming to structure our README as test cases for our .eslintrc?
26+
27+
You can run tests with `npm test`.
28+
29+
You can make sure this module lints with itself using `npm run lint`.

0 commit comments

Comments
 (0)