Skip to content

Commit

Permalink
[eslint-config] docs: add README (#3985)
Browse files Browse the repository at this point in the history
  • Loading branch information
adidahiya authored Feb 27, 2020
1 parent cbb37ca commit 680df58
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions packages/eslint-config/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<img height="204" src="https://cloud.githubusercontent.com/assets/464822/20228152/d3f36dc2-a804-11e6-80ff-51ada2d13ea7.png">

# [Blueprint](http://blueprintjs.com/) [ESLint](https://eslint.org/) Configuration

Blueprint is a React UI toolkit for the web.

This package contains the [ESLint](https://eslint.org/) configuration for Blueprint. It enables lint rules which enforce code style conventions and enables the `@blueprintjs/eslint-plugin-blueprint` plugin.

## Installation

```
yarn add @blueprintjs/eslint-config
```

## Usage

Enable this configuration in your ESLint configuration file (e.g. `.eslintrc.json`):

```json
{
"extends": [
"@blueprintjs/eslint-config"
]
}
```

1 comment on commit 680df58

@blueprint-bot
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[eslint-config] docs: add README (#3985)

Previews: documentation | landing | table

Please sign in to comment.