Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a shareable ESLint configuration package #689

Merged
merged 13 commits into from
Sep 21, 2016
Prev Previous commit
Next Next commit
Update README.md
  • Loading branch information
gaearon committed Sep 21, 2016
commit f2665d8469091275e15f70e83e5450933160bad4
16 changes: 9 additions & 7 deletions packages/eslint-config-react-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,23 @@

This package includes the shareable ESLint configuration used by [Create React App](https://github.com/facebookincubator/create-react-app).

## Installation
## Usage in Create React App Projects

*The easiest way to use this configuration is with [Create React App](https://github.com/facebookincubator/create-react-app), which includes it by default – you* **don't need to install it separately in Create React App projects.**
The easiest way to use this configuration is with [Create React App](https://github.com/facebookincubator/create-react-app), which includes it by default. **You don’t need to install it separately in Create React App projects.**

## Usage Outside of Create React App

If you want to use this ESLint configuration in a project not built with Create React App, you can install it with following steps.

1. Install this package, ESLint and the necessary plugins:
First, install this package, ESLint and the necessary plugins.

```
npm install eslint-config-react-app [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] --save-dev
```sh
npm install --save-dev eslint-config-react-app [email protected] [email protected] [email protected] [email protected] [email protected] [email protected]
```

2. Create a file named `.eslintrc` with following contents in the root folder of your project:
Then create a file named `.eslintrc` with following contents in the root folder of your project:

```
```js
{
"extends": "react-app"
}
Expand Down