From 2d90ebf11b06788f7d686a183182eeacaa767a5c Mon Sep 17 00:00:00 2001 From: Jake Teton-Landis Date: Wed, 19 Aug 2015 14:01:14 -0700 Subject: [PATCH] update README with new package structure --- packages/eslint-config-airbnb/README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/packages/eslint-config-airbnb/README.md b/packages/eslint-config-airbnb/README.md index 6edb34f3..3bc20dc4 100644 --- a/packages/eslint-config-airbnb/README.md +++ b/packages/eslint-config-airbnb/README.md @@ -4,9 +4,26 @@ This package provides Airbnb's .eslintrc as an extensible shared config. ## Usage +### With React Style + 1. `npm install --save-dev eslint-config-airbnb babel-eslint eslint-plugin-react` -2. add `"extends": "eslint-config-airbnb"` to your .eslintrc +2. add `"extends": "airbnb"` to your .eslintrc + +### Without React Style + +1. `npm install --save-dev eslint-config-airbnb babel-eslint ` +2. add `"extends": "airbnb/base"` to your .eslintrc See [Airbnb's Javascript styleguide](https://github.com/airbnb/javascript) and the [ESlint config docs](http://eslint.org/docs/user-guide/configuring#extending-configuration-files) for more information. + +## Improving this config + +Consider adding test cases if you're making complicated rules changes, like +anything involving regexes. Perhaps in a distant future, we could use literate +programming to structure our README as test cases for our .eslintrc? + +You can run tests with `npm test`. + +You can make sure this module lints with itself using `npm run lint`.