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.

Sign up for GitHub

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

[eslint-config] docs: add README #3985

Merged
merged 3 commits into from
Feb 27, 2020
Merged

[eslint-config] docs: add README #3985

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1abc72d
[eslint-config] docs: add README
adidahiya Feb 27, 2020
0861a2c
whoops
adidahiya Feb 27, 2020
e06b552
Update README.md
adidahiya Feb 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions packages/eslint-config/README.md
View file
Open in desktop
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"
]
}
```