-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[eslint-config] docs: add README (#3985)
- Loading branch information
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" | ||
] | ||
} | ||
``` |
680df58
There was a problem hiding this comment.
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